Enum objc2::Encoding

#[non_exhaustive]
pub enum Encoding<'a> {
    Char,
    Short,
    Int,
    Long,
    LongLong,
    UChar,
    UShort,
    UInt,
    ULong,
    ULongLong,
    Float,
    Double,
    LongDouble,
    FloatComplex,
    DoubleComplex,
    LongDoubleComplex,
    Bool,
    Void,
    String,
    Object,
    Block,
    Class,
    Sel,
    Unknown,
    BitField(u8),
    Pointer(&'a Encoding<'a>),
    Array(usize, &'a Encoding<'a>),
    Struct(&'a str, &'a [Encoding<'a>]),
    Union(&'a str, &'a [Encoding<'a>]),
}

An Objective-C type-encoding.

Can be retrieved in Objective-C for a type T using the @encode(T) directive.

NSLog(@"Encoding of NSException: %s", @encode(NSException));

The Display implementation converts the Encoding into its string representation, that the the @encode directive would return. This can be used conveniently through the to_string method:

use objc2_encode::Encoding;
assert_eq!(Encoding::Int.to_string(), "i");

For more information on the string value of an encoding, see Apple’s documentation.

Examples

Comparing an encoding to a string from the Objective-C runtime:

use objc2_encode::Encoding;
assert!(Encoding::Array(10, &Encoding::FloatComplex).equivalent_to_str("[10jf]"));

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Char

A C char. Corresponds to the c code.

Short

A C short. Corresponds to the s code.

Int

A C int. Corresponds to the i code.

Long

A C long. Corresponds to the l code.

LongLong

A C long long. Corresponds to the q code.

UChar

A C unsigned char. Corresponds to the C code.

UShort

A C unsigned short. Corresponds to the S code.

UInt

A C unsigned int. Corresponds to the I code.

ULong

A C unsigned long. Corresponds to the L code.

ULongLong

A C unsigned long long. Corresponds to the Q code.

Float

A C float. Corresponds to the f code.

Double

A C double. Corresponds to the d code.

LongDouble

A C long double. Corresponds to the D code.

FloatComplex

A C float _Complex. Corresponds to the jf code.

DoubleComplex

A C _Complex or double _Complex. Corresponds to the jd code.

LongDoubleComplex

A C long double _Complex. Corresponds to the jD code.

Bool

A C++ bool / C99 _Bool. Corresponds to the B code.

Void

A C void. Corresponds to the v code.

String

A C char *. Corresponds to the * code.

Object

An Objective-C object (id). Corresponds to the @ code.

Block

An Objective-C block. Corresponds to the @? code.

Class

An Objective-C class (Class). Corresponds to the # code.

Sel

An Objective-C selector (SEL). Corresponds to the : code.

Unknown

An unknown type. Corresponds to the ? code.

This is usually used to encode functions.

BitField(u8)

Tuple Fields

0: u8

A bitfield with the given number of bits.

Corresponds to the bnum code.

Pointer(&'a Encoding<'a>)

Tuple Fields

0: &'a Encoding<'a>

A pointer to the given type.

Corresponds to the ^type code.

Array(usize, &'a Encoding<'a>)

Tuple Fields

0: usize

1: &'a Encoding<'a>

An array with the given length and type.

Corresponds to the [len type] code.

Struct(&'a str, &'a [Encoding<'a>])

Tuple Fields

0: &'a str

1: &'a [Encoding<'a>]

A struct with the given name and fields.

The order of the fields must match the order of the order in this.

It is not uncommon for the name to be "?".

Corresponds to the {name=fields...} code.

Union(&'a str, &'a [Encoding<'a>])

Tuple Fields

0: &'a str

1: &'a [Encoding<'a>]

A union with the given name and fields.

The order of the fields must match the order of the order in this.

Corresponds to the (name=fields...) code.

Implementations

impl<'_> Encoding<'_>

pub fn equivalent_to(&self, other: &Encoding<'_>) -> bool

Check if one encoding is equivalent to another.

pub fn equivalent_to_str(&self, s: &str) -> bool

Check if an encoding is equivalent to the given string representation.

pub fn equivalent_to_start_of_str(&self, s: &'a str) -> Option<&'a str>

Check if an encoding is equivalent to the start of the given string representation.

If it is equivalent, the remaining part of the string is returned. Otherwise this returns None.

Trait Implementations

impl<'a> Clone for Encoding<'a>

pub fn clone(&self) -> Encoding<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for Encoding<'a>

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'_> Display for Encoding<'_>

pub fn fmt(&self, formatter: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'a> Hash for Encoding<'a>

pub fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'_> PartialEq<Encoding<'_>> for str

Partial equality between an Encoding and a str.

Using this is heavily discouraged, since it is not transitive; use Encoding::equivalent_to_str instead for more correct semantics.

pub fn eq(&self, other: &Encoding<'_>) -> bool

Using this is discouraged.

pub fn ne(&self, other: &Encoding<'_>) -> bool

Using this is discouraged.

impl<'a> PartialEq<Encoding<'a>> for Encoding<'a>

pub fn eq(&self, other: &Encoding<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &Encoding<'a>) -> bool

This method tests for !=.

impl<'_> PartialEq<str> for Encoding<'_>

Partial equality between an Encoding and a str.

Using this is heavily discouraged, since it is not transitive; use Encoding::equivalent_to_str instead for more correct semantics.

pub fn eq(&self, other: &str) -> bool

Using this is discouraged.

pub fn ne(&self, other: &str) -> bool

Using this is discouraged.

impl<'a> Copy for Encoding<'a>

impl<'a> Eq for Encoding<'a>

impl<'a> StructuralEq for Encoding<'a>

impl<'a> StructuralPartialEq for Encoding<'a>