Struct icrate::Foundation::NSCoder

#[repr(C)]
pub struct NSCoder { /* private fields */ }

Available on crate features Foundation and Foundation_NSCoder only.

Implementations

impl NSCoder

NSAppKitColorExtensions

pub unsafe fn decodeNXColor(&self) -> Option<Id<NSColor>>

👎Deprecated

Available on crate features AppKit and AppKit_NSColor only.

impl NSCoder

pub unsafe fn encodeValueOfObjCType_at( &self, type: NonNull<c_char>, addr: NonNull<c_void> )

pub unsafe fn encodeDataObject(&self, data: &NSData)

Available on crate feature Foundation_NSData only.

pub unsafe fn decodeDataObject(&self) -> Option<Id<NSData>>

Available on crate feature Foundation_NSData only.

pub unsafe fn decodeValueOfObjCType_at_size( &self, type: NonNull<c_char>, data: NonNull<c_void>, size: NSUInteger )

pub unsafe fn versionForClassName(&self, class_name: &NSString) -> NSInteger

Available on crate feature Foundation_NSString only.

impl NSCoder

Methods declared on superclass NSObject

pub unsafe fn init(this: Option<Allocated<Self>>) -> Id<Self>

pub unsafe fn new() -> Id<Self>

impl NSCoder

NSExtendedCoder

pub unsafe fn encodeObject(&self, object: Option<&AnyObject>)

pub unsafe fn encodeRootObject(&self, root_object: &AnyObject)

pub unsafe fn encodeBycopyObject(&self, an_object: Option<&AnyObject>)

pub unsafe fn encodeByrefObject(&self, an_object: Option<&AnyObject>)

pub unsafe fn encodeConditionalObject(&self, object: Option<&AnyObject>)

pub unsafe fn encodeArrayOfObjCType_count_at( &self, type: NonNull<c_char>, count: NSUInteger, array: NonNull<c_void> )

pub unsafe fn encodeBytes_length( &self, byteaddr: *mut c_void, length: NSUInteger )

pub unsafe fn decodeObject(&self) -> Option<Id<AnyObject>>

pub unsafe fn decodeTopLevelObjectAndReturnError( &self ) -> Result<Id<AnyObject>, Id<NSError>>

Available on crate feature Foundation_NSError only.

pub unsafe fn decodeArrayOfObjCType_count_at( &self, item_type: NonNull<c_char>, count: NSUInteger, array: NonNull<c_void> )

pub unsafe fn decodeBytesWithReturnedLength( &self, lengthp: NonNull<NSUInteger> ) -> *mut c_void

pub unsafe fn encodePropertyList(&self, a_property_list: &AnyObject)

pub unsafe fn decodePropertyList(&self) -> Option<Id<AnyObject>>

pub unsafe fn setObjectZone(&self, zone: *mut NSZone)

pub unsafe fn objectZone(&self) -> *mut NSZone

pub unsafe fn systemVersion(&self) -> c_uint

pub unsafe fn allowsKeyedCoding(&self) -> bool

pub unsafe fn encodeObject_forKey( &self, object: Option<&AnyObject>, key: &NSString )

Available on crate feature Foundation_NSString only.

pub unsafe fn encodeConditionalObject_forKey( &self, object: Option<&AnyObject>, key: &NSString )

Available on crate feature Foundation_NSString only.

pub unsafe fn encodeBool_forKey(&self, value: bool, key: &NSString)

Available on crate feature Foundation_NSString only.

pub unsafe fn encodeInt_forKey(&self, value: c_int, key: &NSString)

Available on crate feature Foundation_NSString only.

pub unsafe fn encodeInt32_forKey(&self, value: i32, key: &NSString)

Available on crate feature Foundation_NSString only.

pub unsafe fn encodeInt64_forKey(&self, value: i64, key: &NSString)

Available on crate feature Foundation_NSString only.

pub unsafe fn encodeFloat_forKey(&self, value: c_float, key: &NSString)

Available on crate feature Foundation_NSString only.

pub unsafe fn encodeDouble_forKey(&self, value: c_double, key: &NSString)

Available on crate feature Foundation_NSString only.

pub unsafe fn encodeBytes_length_forKey( &self, bytes: *mut u8, length: NSUInteger, key: &NSString )

Available on crate feature Foundation_NSString only.

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

Available on crate feature Foundation_NSString only.

pub unsafe fn decodeObjectForKey(&self, key: &NSString) -> Option<Id<AnyObject>>

Available on crate feature Foundation_NSString only.

pub unsafe fn decodeTopLevelObjectForKey_error( &self, key: &NSString ) -> Result<Id<AnyObject>, Id<NSError>>

Available on crate features Foundation_NSError and Foundation_NSString only.

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

Available on crate feature Foundation_NSString only.

pub unsafe fn decodeIntForKey(&self, key: &NSString) -> c_int

Available on crate feature Foundation_NSString only.

pub unsafe fn decodeInt32ForKey(&self, key: &NSString) -> i32

Available on crate feature Foundation_NSString only.

pub unsafe fn decodeInt64ForKey(&self, key: &NSString) -> i64

Available on crate feature Foundation_NSString only.

pub unsafe fn decodeFloatForKey(&self, key: &NSString) -> c_float

Available on crate feature Foundation_NSString only.

pub unsafe fn decodeDoubleForKey(&self, key: &NSString) -> c_double

Available on crate feature Foundation_NSString only.

pub unsafe fn decodeBytesForKey_returnedLength( &self, key: &NSString, lengthp: *mut NSUInteger ) -> *mut u8

Available on crate feature Foundation_NSString only.

pub unsafe fn encodeInteger_forKey(&self, value: NSInteger, key: &NSString)

Available on crate feature Foundation_NSString only.

pub unsafe fn decodeIntegerForKey(&self, key: &NSString) -> NSInteger

Available on crate feature Foundation_NSString only.

pub unsafe fn requiresSecureCoding(&self) -> bool

pub unsafe fn decodeObjectOfClass_forKey( &self, a_class: &AnyClass, key: &NSString ) -> Option<Id<AnyObject>>

Available on crate feature Foundation_NSString only.

pub unsafe fn decodeTopLevelObjectOfClass_forKey_error( &self, a_class: &AnyClass, key: &NSString ) -> Result<Id<AnyObject>, Id<NSError>>

Available on crate features Foundation_NSError and Foundation_NSString only.

pub unsafe fn decodeArrayOfObjectsOfClass_forKey( &self, cls: &AnyClass, key: &NSString ) -> Option<Id<NSArray>>

Available on crate features Foundation_NSArray and Foundation_NSString only.

pub unsafe fn decodeDictionaryWithKeysOfClass_objectsOfClass_forKey( &self, key_cls: &AnyClass, object_cls: &AnyClass, key: &NSString ) -> Option<Id<NSDictionary>>

Available on crate features Foundation_NSDictionary and Foundation_NSString only.

pub unsafe fn decodeObjectOfClasses_forKey( &self, classes: Option<&NSSet<AnyObject>>, key: &NSString ) -> Option<Id<AnyObject>>

Available on crate features Foundation_NSSet and Foundation_NSString only.

pub unsafe fn decodeTopLevelObjectOfClasses_forKey_error( &self, classes: Option<&NSSet<AnyObject>>, key: &NSString ) -> Result<Id<AnyObject>, Id<NSError>>

Available on crate features Foundation_NSError and Foundation_NSSet and Foundation_NSString only.

pub unsafe fn decodeArrayOfObjectsOfClasses_forKey( &self, classes: &NSSet<AnyObject>, key: &NSString ) -> Option<Id<NSArray>>

Available on crate features Foundation_NSArray and Foundation_NSSet and Foundation_NSString only.

pub unsafe fn decodeDictionaryWithKeysOfClasses_objectsOfClasses_forKey( &self, key_classes: &NSSet<AnyObject>, object_classes: &NSSet<AnyObject>, key: &NSString ) -> Option<Id<NSDictionary>>

Available on crate features Foundation_NSDictionary and Foundation_NSSet and Foundation_NSString only.

pub unsafe fn decodePropertyListForKey( &self, key: &NSString ) -> Option<Id<AnyObject>>

Available on crate feature Foundation_NSString only.

pub unsafe fn allowedClasses(&self) -> Option<Id<NSSet<AnyObject>>>

Available on crate feature Foundation_NSSet only.

pub unsafe fn failWithError(&self, error: &NSError)

Available on crate feature Foundation_NSError only.

pub unsafe fn decodingFailurePolicy(&self) -> NSDecodingFailurePolicy

pub unsafe fn error(&self) -> Option<Id<NSError>>

Available on crate feature Foundation_NSError only.

impl NSCoder

NSTypedstreamCompatibility

pub unsafe fn encodeNXObject(&self, object: &AnyObject)

👎Deprecated: Not supported

pub unsafe fn decodeNXObject(&self) -> Option<Id<AnyObject>>

👎Deprecated: Not supported

impl NSCoder

NSDeprecated

pub unsafe fn decodeValueOfObjCType_at( &self, type: NonNull<c_char>, data: NonNull<c_void> )

👎Deprecated

impl NSCoder

NSGeometryCoding

pub unsafe fn encodePoint(&self, point: NSPoint)

pub unsafe fn decodePoint(&self) -> NSPoint

pub unsafe fn encodeSize(&self, size: NSSize)

pub unsafe fn decodeSize(&self) -> NSSize

pub unsafe fn encodeRect(&self, rect: NSRect)

pub unsafe fn decodeRect(&self) -> NSRect

impl NSCoder

NSGeometryKeyedCoding

pub unsafe fn encodePoint_forKey(&self, point: NSPoint, key: &NSString)

Available on crate feature Foundation_NSString only.

pub unsafe fn encodeSize_forKey(&self, size: NSSize, key: &NSString)

Available on crate feature Foundation_NSString only.

pub unsafe fn encodeRect_forKey(&self, rect: NSRect, key: &NSString)

Available on crate feature Foundation_NSString only.

pub unsafe fn decodePointForKey(&self, key: &NSString) -> NSPoint

Available on crate feature Foundation_NSString only.

pub unsafe fn decodeSizeForKey(&self, key: &NSString) -> NSSize

Available on crate feature Foundation_NSString only.

pub unsafe fn decodeRectForKey(&self, key: &NSString) -> NSRect

Available on crate feature Foundation_NSString only.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &AnyClass

Dynamically find the class of this object.

pub unsafe fn ivar_ptr<T>(&self, name: &str) -> *mut Twhere T: Encode,

Returns a pointer to the instance variable / ivar with the given name.

This is similar to UnsafeCell::get, see that for more information on what is and isn’t safe to do.

Usually you will have defined the instance variable yourself with ClassBuilder::add_ivar, the type of the ivar T must match the type used in that.

Attempting to access or modify private implementation details of a class that you do no control using this is not supported, and may invoke undefined behaviour.

Library implementors are strongly encouraged to expose a safe interface to the ivar.

Panics

May panic if the object has no ivar with the given name. May also panic if the type encoding of the ivar differs from the type encoding of T.

This should purely seen as help while debugging and is not guaranteed (e.g. it may be disabled when debug_assertions are off).

Safety

The object must have an instance variable with the given name, and it must be of type T. Any invariants that the object have assumed about the value of the instance variable must not be violated.

No thread syncronization is done on accesses to the variable, so you must ensure that any access to the returned pointer do not cause data races, and that Rust’s mutability rules are not otherwise violated.

pub unsafe fn ivar<T>(&self, name: &str) -> &Twhere T: Encode,

Returns a reference to the instance variable with the given name.

See AnyObject::ivar_ptr for more information, including on when this panics.

Safety

The object must have an instance variable with the given name, and it must be of type T.

No thread syncronization is done, so you must ensure that no other thread is concurrently mutating the variable. This requirement can be considered upheld if all mutation happens through AnyObject::ivar_mut (since that takes &mut self).

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

👎Deprecated: Use AnyObject::ivar instead.

Use AnyObject::ivar instead.

Safety

See AnyObject::ivar.

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

Returns a mutable reference to the ivar with the given name.

See AnyObject::ivar_ptr for more information, including on when this panics.

Safety

The object must have an instance variable with the given name, and it must be of type T.

This access happens through &mut self, which means we know it to be the only reference, hence you do not need to do any work to ensure that data races do not happen.

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

👎Deprecated: Use AnyObject::ivar_mut instead.

Use AnyObject::ivar_mut instead.

Safety

Same as AnyObject::ivar_mut.

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

Sets the value of the ivar with the given name.

This is a shorthand for AnyObject::ivar_mut, see that for more information.

Safety

Same as AnyObject::ivar_mut.

Trait Implementations

impl AsMut<AnyObject> for NSCoder

fn as_mut(&mut self) -> &mut AnyObject

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<NSCoder> for NSArchiver

fn as_mut(&mut self) -> &mut NSCoder

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<NSCoder> for NSCoder

fn as_mut(&mut self) -> &mut Self

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<NSCoder> for NSKeyedArchiver

fn as_mut(&mut self) -> &mut NSCoder

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<NSCoder> for NSKeyedUnarchiver

fn as_mut(&mut self) -> &mut NSCoder

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<NSCoder> for NSPortCoder

fn as_mut(&mut self) -> &mut NSCoder

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<NSCoder> for NSUnarchiver

fn as_mut(&mut self) -> &mut NSCoder

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<NSCoder> for NSXPCCoder

fn as_mut(&mut self) -> &mut NSCoder

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<NSObject> for NSCoder

fn as_mut(&mut self) -> &mut NSObject

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<AnyObject> for NSCoder

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSCoder> for NSArchiver

fn as_ref(&self) -> &NSCoder

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSCoder> for NSCoder

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSCoder> for NSKeyedArchiver

fn as_ref(&self) -> &NSCoder

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSCoder> for NSKeyedUnarchiver

fn as_ref(&self) -> &NSCoder

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSCoder> for NSPortCoder

fn as_ref(&self) -> &NSCoder

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSCoder> for NSUnarchiver

fn as_ref(&self) -> &NSCoder

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSCoder> for NSXPCCoder

fn as_ref(&self) -> &NSCoder

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for NSCoder

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for NSCoder

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSCoder> for NSArchiver

fn borrow(&self) -> &NSCoder

Immutably borrows from an owned value.

impl Borrow<NSCoder> for NSKeyedArchiver

fn borrow(&self) -> &NSCoder

Immutably borrows from an owned value.

impl Borrow<NSCoder> for NSKeyedUnarchiver

fn borrow(&self) -> &NSCoder

Immutably borrows from an owned value.

impl Borrow<NSCoder> for NSPortCoder

fn borrow(&self) -> &NSCoder

Immutably borrows from an owned value.

impl Borrow<NSCoder> for NSUnarchiver

fn borrow(&self) -> &NSCoder

Immutably borrows from an owned value.

impl Borrow<NSCoder> for NSXPCCoder

fn borrow(&self) -> &NSCoder

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSCoder

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl BorrowMut<AnyObject> for NSCoder

fn borrow_mut(&mut self) -> &mut AnyObject

Mutably borrows from an owned value.

impl BorrowMut<NSCoder> for NSArchiver

fn borrow_mut(&mut self) -> &mut NSCoder

Mutably borrows from an owned value.

impl BorrowMut<NSCoder> for NSKeyedArchiver

fn borrow_mut(&mut self) -> &mut NSCoder

Mutably borrows from an owned value.

impl BorrowMut<NSCoder> for NSKeyedUnarchiver

fn borrow_mut(&mut self) -> &mut NSCoder

Mutably borrows from an owned value.

impl BorrowMut<NSCoder> for NSPortCoder

fn borrow_mut(&mut self) -> &mut NSCoder

Mutably borrows from an owned value.

impl BorrowMut<NSCoder> for NSUnarchiver

fn borrow_mut(&mut self) -> &mut NSCoder

Mutably borrows from an owned value.

impl BorrowMut<NSCoder> for NSXPCCoder

fn borrow_mut(&mut self) -> &mut NSCoder

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for NSCoder

fn borrow_mut(&mut self) -> &mut NSObject

Mutably borrows from an owned value.

impl ClassType for NSCoder

type Super = NSObject

The superclass of this class.

type Mutability = InteriorMutable

Whether the type is mutable or immutable.

const NAME: &'static str = _

The name of the Objective-C class that this type represents.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

fn as_super_mut(&mut self) -> &mut Self::Super

Get a mutable reference to the superclass.

fn retain(&self) -> Id<Self>where Self: IsRetainable + Sized,

Increment the reference count of the receiver.

fn alloc() -> Option<Allocated<Self>>where Self: IsAllocableAnyThread,

Allocate a new instance of the class.

impl Debug for NSCoder

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

Formats the value using the given formatter.

impl Deref for NSCoder

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for NSCoder

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

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

fn is_kind_of<T>(&self) -> boolwhere T: ClassType, Self: Sized + Message,

Check if the object is an instance of the class, or one of it’s subclasses.

impl PartialEq<NSCoder> for NSCoder

fn eq(&self, other: &NSCoder) -> 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 RefEncode for NSCoder

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl Eq for NSCoder

impl Message for NSCoder

impl StructuralEq for NSCoder

impl StructuralPartialEq for NSCoder