Struct NSCoder

#[repr(C)]
pub struct NSCoder {
    pub ptr: Id<Object>,
}

An abstract class that serves as the basis for objects that enable archiving and distribution of other objects.

Fields

ptr: Id<Object>

The raw pointer to the Objective-C object.

Implementations

impl NSCoder

pub fn allows_keyed_coding(&self) -> bool

Returns a Boolean value that indicates whether an encoded value is available for a string.

pub fn contains_value_for_key(&self, key: NSString) -> bool

Returns a Boolean value that indicates whether an encoded value is available for a string.

pub fn decoding_failure_policy(&self) -> NSDecodingFailurePolicy

The action the coder should take when decoding fails.

pub fn encode_array_of_objc_type_count_at( &mut self, type_: *const c_char, count: usize, array: *const c_void, )

Encodes an array of the given Objective-C type, provided the number of items and a pointer.

pub fn encode_bool_for_key(&mut self, value: bool, key: NSString)

Encodes a Boolean value and associates it with the string key.

pub fn encode_bycopy_object<T>(&mut self, object: T)

where T: PNSObject + ToId,

An encoding method for subclasses to override such that it creates a copy, rather than a proxy, when decoded.

pub fn encode_byref_object<T>(&mut self, object: T)

where T: PNSObject,

An encoding method for subclasses to override such that it creates a proxy, rather than a copy, when decoded.

pub fn encode_bytes_length(&mut self, bytes: *const c_void, length: UInt)

Encodes a buffer of data of an unspecified type.

pub fn encode_bytes_length_for_key( &mut self, bytes: *const UInt8, length: UInt, key: NSString, )

Encodes a buffer of data, given its length and a pointer, and associates it with a string key.

pub fn encode_conditional_object<T>(&mut self, object: T)

where T: PNSObject,

An encoding method for subclasses to override to conditionally encode an object, preserving common references to it.

pub fn encode_conditional_object_for_key<T>(&mut self, object: T, key: NSString)

where T: PNSObject,

An encoding method for subclasses to override to conditionally encode an object, preserving common references to it, only if it has been unconditionally encoded.

pub fn encode_data_object<T>(&mut self, object: T)

where T: PNSObject,

Encodes a given data object.

pub fn encode_double_for_key(&mut self, value: c_double, key: NSString)

Encodes a double-precision floating point value and associates it with the string key.

pub fn encode_float_for_key(&mut self, value: c_float, key: NSString)

Encodes a floating point value and associates it with the string key.

pub fn encode_int_for_key(&mut self, value: Int, key: NSString)

Encodes a C integer value and associates it with the string key.

pub fn encode_integer_for_key(&mut self, value: Int, key: NSString)

Encodes an integer value and associates it with the string key.

pub fn encode_int32_for_key(&mut self, value: Int32, key: NSString)

Encodes a 32-bit integer value and associates it with the string key.

pub fn encode_int64_for_key(&mut self, value: Int64, key: NSString)

Encodes a 64-bit integer value and associates it with the string key.

pub fn encode_object<T>(&mut self, object: T)

where T: PNSObject,

Encodes an object.

pub fn encode_object_for_key<T>(&mut self, object: T, key: NSString)

where T: PNSObject,

Encodes an object and associates it with the string key.

pub fn encode_point(&mut self, point: NSPoint)

Encodes a point.

pub fn encode_point_for_key(&mut self, point: NSPoint, key: NSString)

Encodes a point and associates it with the string key.

pub fn encode_property_list(&mut self, property_list: id)

Encodes a property list.

pub fn encode_rect(&mut self, rect: NSRect)

Encodes a rectangle structure.

pub fn encode_rect_for_key(&mut self, rect: NSRect, key: NSString)

Encodes a rectangle structure and associates it with the string key.

pub fn encode_root_object(&mut self, root_object: id)

An encoding method for subclasses to override to encode an interconnected group of objects, starting with the provided root object.

pub fn encode_size(&mut self, size: NSSize)

Encodes a size structure.

pub fn encode_size_for_key(&mut self, size: NSSize, key: NSString)

Encodes a size structure and associates it with the given string key.

pub fn encode_value_of_objc_type_at( &mut self, _type: *const c_char, addr: *const c_void, )

Encodes a value of the given type at the given address.

pub fn encode_cgpoint_for_key(&mut self, point: CGPoint, key: NSString)

Encodes a point and associates it with the specified key in the receiver’s archive.

pub fn encode_cgrect_for_key(&mut self, rect: CGRect, key: NSString)

Encodes a rectangle and associates it with the specified key in the receiver’s archive.

pub fn encode_cgzize_for_key(&mut self, size: CGSize, key: NSString)

Encodes size information and associates it with the specified key in the coder’s archive.

Methods from Deref<Target = Object>

pub fn class(&self) -> &Class

Returns the class of self.

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

Returns a reference to the ivar of self with the given name. Panics if self has no ivar with the given name. Unsafe because the caller must ensure that the ivar is actually of type T.

pub unsafe fn get_mut_ivar<T>(&mut self, name: &str) -> &mut T

where T: Encode,

Returns a mutable reference to the ivar of self with the given name. Panics if self has no ivar with the given name. Unsafe because the caller must ensure that the ivar is actually of type T.

pub unsafe fn set_ivar<T>(&mut self, name: &str, value: T)

where T: Encode,

Sets the value of the ivar of self with the given name. Panics if self has no ivar with the given name. Unsafe because the caller must ensure that the ivar is actually of type T.

Trait Implementations

impl Clone for NSCoder

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NSCoder

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

Formats the value using the given formatter.

impl Deref for NSCoder

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for NSCoder

fn deref_mut(&mut self) -> &mut Object

Mutably dereferences the value.

impl Display for NSCoder

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

Formats the value using the given formatter.

impl Encode for NSCoder

fn encode() -> Encoding

Returns the Objective-C type encoding for Self.

impl FromId for NSCoder

unsafe fn from_id(ptr: id) -> Self

Returns Self representation of the object.

impl Hash for NSCoder

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 INSCoder for NSCoder

fn p_allows_keyed_coding(&self) -> bool

Returns a Boolean value that indicates whether an encoded value is available for a string.

fn m_contains_value_for_key(&self, key: NSString) -> bool

Returns a Boolean value that indicates whether an encoded value is available for a string.

fn p_decoding_failure_policy(&self) -> NSDecodingFailurePolicy

The action the coder should take when decoding fails.

fn m_encode_array_of_objc_type_count_at( &mut self, type_: *const c_char, count: usize, array: *const c_void, )

Encodes an array of the given Objective-C type, provided the number of items and a pointer.

fn m_encode_bool_for_key(&mut self, value: bool, key: NSString)

Encodes a Boolean value and associates it with the string key.

fn m_encode_bycopy_object<T>(&mut self, object: T)

where T: PNSObject + ToId,

An encoding method for subclasses to override such that it creates a copy, rather than a proxy, when decoded.

fn m_encode_byref_object<T>(&mut self, object: T)

where T: PNSObject,

An encoding method for subclasses to override such that it creates a proxy, rather than a copy, when decoded.

fn m_encode_bytes_length(&mut self, bytes: *const c_void, length: UInt)

Encodes a buffer of data of an unspecified type.

fn m_encode_bytes_length_for_key( &mut self, bytes: *const UInt8, length: UInt, key: NSString, )

Encodes a buffer of data, given its length and a pointer, and associates it with a string key.

fn m_encode_conditional_object<T>(&mut self, object: T)

where T: PNSObject,

An encoding method for subclasses to override to conditionally encode an object, preserving common references to it.

fn m_encode_conditional_object_for_key<T>(&mut self, object: T, key: NSString)

where T: PNSObject,

An encoding method for subclasses to override to conditionally encode an object, preserving common references to it, only if it has been unconditionally encoded.

fn m_encode_data_object<T>(&mut self, object: T)

where T: PNSObject,

Encodes a given data object.

fn m_encode_double_for_key(&mut self, value: c_double, key: NSString)

Encodes a double-precision floating point value and associates it with the string key.

fn m_encode_float_for_key(&mut self, value: c_float, key: NSString)

Encodes a floating point value and associates it with the string key.

fn m_encode_int_for_key(&mut self, value: Int, key: NSString)

Encodes a C integer value and associates it with the string key.

fn m_encode_integer_for_key(&mut self, value: Int, key: NSString)

Encodes an integer value and associates it with the string key.

fn m_encode_int32_for_key(&mut self, value: Int32, key: NSString)

Encodes a 32-bit integer value and associates it with the string key.

fn m_encode_int64_for_key(&mut self, value: Int64, key: NSString)

Encodes a 64-bit integer value and associates it with the string key.

fn m_encode_object<T>(&mut self, object: T)

where T: PNSObject,

Encodes an object.

fn m_encode_object_for_key<T>(&mut self, object: T, key: NSString)

where T: PNSObject,

Encodes an object and associates it with the string key.

fn m_encode_point(&mut self, point: NSPoint)

Encodes a point.

fn m_encode_point_for_key(&mut self, point: NSPoint, key: NSString)

Encodes a point and associates it with the string key.

fn m_encode_property_list(&mut self, property_list: id)

Encodes a property list.

fn m_encode_rect(&mut self, rect: NSRect)

Encodes a rectangle structure.

fn m_encode_rect_for_key(&mut self, rect: NSRect, key: NSString)

Encodes a rectangle structure and associates it with the string key.

fn m_encode_root_object(&mut self, root_object: id)

An encoding method for subclasses to override to encode an interconnected group of objects, starting with the provided root object.

fn m_encode_size(&mut self, size: NSSize)

Encodes a size structure.

fn m_encode_size_for_key(&mut self, size: NSSize, key: NSString)

Encodes a size structure and associates it with the given string key.

fn m_encode_value_of_objc_type_at( &mut self, _type: *const c_char, addr: *const c_void, )

Encodes a value of the given type at the given address.

fn m_encode_cgpoint_for_key(&mut self, point: CGPoint, key: NSString)

Encodes a point and associates it with the specified key in the receiver’s archive.

fn m_encode_cgrect_for_key(&mut self, rect: CGRect, key: NSString)

Encodes a rectangle and associates it with the specified key in the receiver’s archive.

fn m_encode_cgzize_for_key(&mut self, size: CGSize, key: NSString)

Encodes size information and associates it with the specified key in the coder’s archive.

impl PNSObject for NSCoder

fn m_class<'a>() -> &'a Class

Returns the class object for the receiver’s class.

fn m_self(&self) -> id

Returns the receiver.

fn m_new() -> Self

where Self: Sized + FromId,

Allocates a new instance of the receiving class, sends it an init message, and returns the initialized object.

fn m_alloc() -> Self

where Self: Sized + FromId,

Returns a new instance of the receiving class.

fn m_initialize()

Initializes the class before it receives its first message.

fn ip_superclass<'a>() -> Option<&'a Class>

Returns the class object for the receiver’s superclass.

fn m_is_equal(&self, object: &Self) -> bool

Returns a Boolean value that indicates whether the receiver and a given object are equal.

fn p_hash(&self) -> UInt

Returns an integer that can be used as a table address in a hash table structure.

fn m_is_kind_of_class(&self, class: Class) -> bool

Returns a Boolean value that indicates whether the receiver is an instance of given class or an instance of any class that inherits from that class.

fn m_is_member_of_class(&self, class: Class) -> bool

Returns a Boolean value that indicates whether the receiver is an instance of a given class.

fn m_responds_to_selector(&self, selector: Sel) -> bool

Returns a Boolean value that indicates whether the receiver implements or inherits a method that can respond to a specified message.

fn m_conforms_to_protocol(&self, protocol: Protocol) -> bool

Returns a Boolean value that indicates whether the receiver conforms to a given protocol.

fn p_description(&self) -> NSString

A textual representation of the receiver.

fn p_debug_description(&self) -> NSString

A textual representation of the receiver to use with a debugger.

fn m_perform_selector(&self, selector: Sel) -> id

Sends a specified message to the receiver and returns the result of the message.

fn m_perform_selector_with_object(&self, selector: Sel, with_object: id) -> id

Sends a message to the receiver with an object as the argument.

fn m_is_proxy(&self) -> bool

Returns a Boolean value that indicates whether the receiver does not descend from NSObject.

impl ToId for NSCoder

fn to_id(self) -> id

Returns id representation of the object.