1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
/*!
Objective-C type encoding creation and parsing in Rust.
The Objective-C compiler encodes types as strings for usage in the runtime.
This crate aims to provide a strongly-typed (rather than stringly-typed) way
to create and describe these type encodings without memory allocation in Rust.
# Implementing Encode
This crate declares an `Encode` trait that can be implemented for types that
the Objective-C compiler can encode. Implementing this trait looks like:
``` ignore
unsafe impl Encode for CGPoint {
const ENCODING: Encoding<'static> =
Encoding::Struct("CGPoint", &[CGFloat::ENCODING, CGFLOAT::ENCODING]);
}
```
For an example of how this works with more complex types, like structs
containing structs, see the `core_graphics` example.
# Comparing with encoding strings
An `Encoding` can be compared with an encoding string from the Objective-C
runtime:
```
# use objc_encode::Encode;
assert!(&i32::ENCODING == "i");
```
# Generating encoding strings
Every `Encoding` implements `Display` as its string representation.
This can be generated conveniently through the `to_string` method:
```
# use objc_encode::Encode;
assert_eq!(i32::ENCODING.to_string(), "i");
```
*/
#![no_std]
#[cfg(test)]
extern crate std;
mod encoding;
mod encode;
mod parse;
pub use crate::encoding::Encoding;
pub use crate::encode::Encode;