Skip to content

Commit ac9fdbf

Browse files
committed
Update text surrounding objc2::foundation
1 parent 4346f3e commit ac9fdbf

File tree

3 files changed

+22
-22
lines changed

3 files changed

+22
-22
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,8 @@ appreciated!
1212
## Crate overview
1313

1414
The core crate is [`objc2`], which contains everything you need to interface
15-
with Objective-C. We use it in [`objc2-foundation`] to provide a safe
16-
abstraction over some core objects from the Foundation Framework, since these
17-
are used in almost all other Objective-C frameworks.
15+
with Objective-C. It also provides safe abstraction over (parts of) the
16+
Foundation Framework, since that is used in almost all Objective-C code.
1817

1918
[`block2`] has a bit of a weird position in all of this: Apple's C language
2019
extension of blocks is _technically_ not limited to being used in Objective-C,
@@ -27,7 +26,6 @@ separate crate to help people cutting down on unneeded dependencies.
2726
runtime libraries.
2827

2928
[`objc2`]: ./objc2
30-
[`objc2-foundation`]: ./objc2-foundation
3129
[`block2`]: ./block2
3230
[`objc2-encode`]: ./objc2-encode
3331
[`objc-sys`]: ./objc-sys
@@ -126,21 +124,27 @@ Work is in progress to make it dual-licensed under the Apache License
126124

127125
## Acknowledgements
128126

129-
This repository is originally a fork of [`objc`] (hence the name `objc2`),
130-
with the following projects merged into it (see reasoning for the fork
131-
[here][origin-issue-101]):
127+
This repository is a merge of the following projects, see reasoning for the
128+
fork [here][origin-issue-101]:
129+
- [`objc`](https://github.com/SSheldon/rust-objc)
130+
- Renamed to `objc2`.
132131
- [`objc-encode`](https://github.com/SSheldon/rust-objc-encode)
132+
- Renamed to `objc2-encode`.
133133
- [`objc_exception`](https://github.com/SSheldon/rust-objc-exception)
134+
- Moved to `objc2::exception`.
134135
- [`objc_id`](https://github.com/SSheldon/rust-objc-id)
136+
- Moved to `objc2::rc`.
135137
- [`objc-foundation`](https://github.com/SSheldon/rust-objc-foundation)
138+
- Moved to `objc2::foundation`.
136139
- [`block`](https://github.com/SSheldon/rust-block)
140+
- Renamed to `block2`.
137141

138142
These were created almost solely by [@SSheldon](https://github.com/SSheldon),
139143
so a huge thanks for their fantastic work on these crates!
140144

141-
This project also draws heavy inspiration from [`fruity`] and [`objrs`].
145+
This project also draws heavy inspiration from [`fruity`], the [`core-foundation-rs` project] and [`objrs`].
142146

143-
[`objc`]: https://github.com/SSheldon/rust-objc
144147
[origin-issue-101]: https://github.com/SSheldon/rust-objc/issues/101
145148
[`fruity`]: https://github.com/nvzqz/fruity
149+
[`core-foundation-rs` project]: https://github.com/servo/core-foundation-rs
146150
[`objrs`]: https://gitlab.com/objrs/objrs

objc2/src/foundation/mod.rs

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,10 @@
1-
//! # Bindings to the Objective-C Cocoa `Foundation` framework
1+
//! Bindings to the `Foundation` framework.
22
//!
3-
//! The [`std`] equivalent for Objective-C, containing essential data types,
4-
//! collections, and operating-system services.
3+
//! This is the [`std`] equivalent for Objective-C, containing essential data
4+
//! types, collections, and operating-system services.
55
//!
66
//! See [Apple's documentation](https://developer.apple.com/documentation/foundation?language=objc).
77
//!
8-
//! **NOTICE: This library is very much in progress, consider using the more
9-
//! battle-tested [`cocoa-foundation`] crate in the meantime.**
10-
//!
11-
//! [`cocoa-foundation`]: https://crates.io/crates/cocoa-foundation
128
//!
139
//! ## Philosophy
1410
//!
@@ -18,12 +14,13 @@
1814
//! on conversion methods, to allow easily using them from Rust.
1915
//!
2016
//! If you find some API that an object doesn't expose (but should), we gladly
21-
//! accept [pull requests]. Anyhow, if it is something that is out of scope,
22-
//! these objects implement the [`objc2::Message`] trait, so you can always
23-
//! just manually implement call a method using the [`objc2::msg_send!`]
24-
//! macro.
17+
//! accept [pull requests]. If it is something that is out of scope, these
18+
//! objects implement the [`Message`] trait, so you can always just manually
19+
//! call a method on them using the [`msg_send!`] family of macros.
2520
//!
2621
//! [pull requests]: https://github.com/madsmtm/objc2/pulls
22+
//! [`Message`]: crate::Message
23+
//! [`msg_send!`]: crate::msg_send
2724
2825
// TODO: Remove these
2926
#![allow(missing_docs)]

objc2/src/lib.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@
7575
//! other type, and this would trigger undefined behaviour!
7676
//!
7777
//! Making the ergonomics better is something that is currently being worked
78-
//! on, see e.g. the [`objc2-foundation`] crate for more ergonomic usage of at
78+
//! on, the [`objc2::foundation`] module contains more ergonomic usage of at
7979
//! least parts of the `Foundation` framework.
8080
//!
8181
//! Anyhow, all of this `unsafe` nicely leads us to another feature that this
@@ -85,7 +85,6 @@
8585
//! [`runtime::Object`]: crate::runtime::Object
8686
//! [`rc::Owned`]: crate::rc::Owned
8787
//! [`rc::Id`]: crate::rc::Id
88-
//! [`objc2-foundation`]: https://crates.io/crates/objc2-foundation
8988
//!
9089
//!
9190
//! ## Encodings and message type verification

0 commit comments

Comments
 (0)