Enum objc2_encode::EncodingBox

#[non_exhaustive]
pub enum EncodingBox {
    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, Option<Box<(u64, Self)>>),
    Pointer(Box<Self>),
    Atomic(Box<Self>),
    Array(u64, Box<Self>),
    Struct(String, Option<Vec<Self>>),
    Union(String, Option<Vec<Self>>),
}

The boxed version of Encoding.

This has exactly the same items as Encoding, the only difference is in where the contents of the more complex encodings like Struct are stored.

In Encoding, the data is stored in static memory, while in EncodingBox it is stored on the heap. The former allows storing in constants (which is required by the objc2::encode::Encode and objc2::encode::RefEncode traits), while the latter allows dynamic creation, such as in the case of parsing encodings.

This should be considered a temporary restriction. Encoding and EncodingBox will become equivalent once heap allocation in constants is possible.

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

Same as Encoding::Char.

Short

Same as Encoding::Short.

Int

Same as Encoding::Int.

Long

Same as Encoding::Long.

LongLong

Same as Encoding::LongLong.

UChar

Same as Encoding::UChar.

UShort

Same as Encoding::UShort.

UInt

Same as Encoding::UInt.

ULong

Same as Encoding::ULong.

ULongLong

Same as Encoding::ULongLong.

Float

Same as Encoding::Float.

Double

Same as Encoding::Double.

LongDouble

Same as Encoding::LongDouble.

FloatComplex

Same as Encoding::FloatComplex.

DoubleComplex

Same as Encoding::DoubleComplex.

LongDoubleComplex

Same as Encoding::LongDoubleComplex.

Bool

Same as Encoding::Bool.

Void

Same as Encoding::Void.

String

Same as Encoding::String.

Object

Same as Encoding::Object.

Block

Same as Encoding::Block.

Class

Same as Encoding::Class.

Sel

Same as Encoding::Sel.

Unknown

Same as Encoding::Unknown.

BitField(u8, Option<Box<(u64, Self)>>)

Same as Encoding::BitField.

Pointer(Box<Self>)

Same as Encoding::Pointer.

Atomic(Box<Self>)

Same as Encoding::Atomic.

Array(u64, Box<Self>)

Same as Encoding::Array.

Struct(String, Option<Vec<Self>>)

Same as Encoding::Struct.

Union(String, Option<Vec<Self>>)

Same as Encoding::Union.

Implementations

impl EncodingBox

pub const C_LONG: Self = _

Same as Encoding::C_LONG.

pub const C_ULONG: Self = _

Same as Encoding::C_ULONG.

pub fn from_start_of_str(s: &mut &str) -> Result<Self, ParseError>

Parse and comsume an encoding from the start of a string.

This is can be used to parse concatenated encodings, such as those returned by method_getTypeEncoding.

from_str is simpler, use that instead if you can.

Trait Implementations

impl Clone for EncodingBox

fn clone(&self) -> EncodingBox

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EncodingBox

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

Formats the value using the given formatter.

impl Display for EncodingBox

Same formatting as Encoding’s Display implementation.

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

Formats the value using the given formatter.

impl FromStr for EncodingBox

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for EncodingBox

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<Encoding> for EncodingBox

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<EncodingBox> for Encoding

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<EncodingBox> for EncodingBox

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for EncodingBox

impl StructuralEq for EncodingBox

impl StructuralPartialEq for EncodingBox