Struct objc2_foundation::NSData

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

Available on crate feature NSData only.

Implementations

impl NSData

pub fn with_bytes(bytes: &[u8]) -> Retained<Self>

pub fn from_vec(bytes: Vec<u8>) -> Retained<Self>

Available on crate feature block2 only.

impl NSData

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn bytes(&self) -> &[u8]

impl NSData

pub fn length(&self) -> NSUInteger

impl NSData

Methods declared on superclass NSObject

pub fn init(this: Allocated<Self>) -> Retained<Self>

pub fn new() -> Retained<Self>

impl NSData

NSExtendedData

pub unsafe fn description(&self) -> Retained<NSString>

Available on crate feature NSString only.

pub unsafe fn getBytes_length( &self, buffer: NonNull<c_void>, length: NSUInteger )

pub unsafe fn getBytes_range(&self, buffer: NonNull<c_void>, range: NSRange)

Available on crate feature NSRange only.

pub unsafe fn isEqualToData(&self, other: &NSData) -> bool

pub unsafe fn subdataWithRange(&self, range: NSRange) -> Retained<NSData>

Available on crate feature NSRange only.

pub unsafe fn writeToFile_atomically( &self, path: &NSString, use_auxiliary_file: bool ) -> bool

Available on crate feature NSString only.

pub unsafe fn writeToURL_atomically( &self, url: &NSURL, atomically: bool ) -> bool

Available on crate feature NSURL only.

pub unsafe fn writeToFile_options_error( &self, path: &NSString, write_options_mask: NSDataWritingOptions ) -> Result<(), Retained<NSError>>

Available on crate features NSError and NSString only.

pub unsafe fn writeToURL_options_error( &self, url: &NSURL, write_options_mask: NSDataWritingOptions ) -> Result<(), Retained<NSError>>

Available on crate features NSError and NSURL only.

pub unsafe fn rangeOfData_options_range( &self, data_to_find: &NSData, mask: NSDataSearchOptions, search_range: NSRange ) -> NSRange

Available on crate feature NSRange only.

pub unsafe fn enumerateByteRangesUsingBlock( &self, block: &Block<dyn Fn(NonNull<c_void>, NSRange, NonNull<Bool>) + '_> )

Available on crate features NSRange and block2 only.

impl NSData

NSDataCreation

pub unsafe fn data() -> Retained<Self>

pub unsafe fn dataWithBytes_length( bytes: *mut c_void, length: NSUInteger ) -> Retained<Self>

pub unsafe fn dataWithBytesNoCopy_length( bytes: NonNull<c_void>, length: NSUInteger ) -> Retained<Self>

pub unsafe fn dataWithBytesNoCopy_length_freeWhenDone( bytes: NonNull<c_void>, length: NSUInteger, b: bool ) -> Retained<Self>

pub unsafe fn dataWithContentsOfFile_options_error( path: &NSString, read_options_mask: NSDataReadingOptions ) -> Result<Retained<Self>, Retained<NSError>>

Available on crate features NSError and NSString only.

pub unsafe fn dataWithContentsOfURL_options_error( url: &NSURL, read_options_mask: NSDataReadingOptions ) -> Result<Retained<Self>, Retained<NSError>>

Available on crate features NSError and NSURL only.

pub unsafe fn dataWithContentsOfFile(path: &NSString) -> Option<Retained<Self>>

Available on crate feature NSString only.

pub unsafe fn dataWithContentsOfURL(url: &NSURL) -> Option<Retained<Self>>

Available on crate feature NSURL only.

pub unsafe fn initWithBytes_length( this: Allocated<Self>, bytes: *mut c_void, length: NSUInteger ) -> Retained<Self>

pub unsafe fn initWithBytesNoCopy_length( this: Allocated<Self>, bytes: NonNull<c_void>, length: NSUInteger ) -> Retained<Self>

pub unsafe fn initWithBytesNoCopy_length_freeWhenDone( this: Allocated<Self>, bytes: NonNull<c_void>, length: NSUInteger, b: bool ) -> Retained<Self>

pub unsafe fn initWithBytesNoCopy_length_deallocator( this: Allocated<Self>, bytes: NonNull<c_void>, length: NSUInteger, deallocator: Option<&Block<dyn Fn(NonNull<c_void>, NSUInteger)>> ) -> Retained<Self>

Available on crate feature block2 only.

pub unsafe fn initWithContentsOfFile_options_error( this: Allocated<Self>, path: &NSString, read_options_mask: NSDataReadingOptions ) -> Result<Retained<Self>, Retained<NSError>>

Available on crate features NSError and NSString only.

pub unsafe fn initWithContentsOfURL_options_error( this: Allocated<Self>, url: &NSURL, read_options_mask: NSDataReadingOptions ) -> Result<Retained<Self>, Retained<NSError>>

Available on crate features NSError and NSURL only.

pub unsafe fn initWithContentsOfFile( this: Allocated<Self>, path: &NSString ) -> Option<Retained<Self>>

Available on crate feature NSString only.

pub unsafe fn initWithContentsOfURL( this: Allocated<Self>, url: &NSURL ) -> Option<Retained<Self>>

Available on crate feature NSURL only.

pub fn initWithData(this: Allocated<Self>, data: &NSData) -> Retained<Self>

pub fn dataWithData(data: &NSData) -> Retained<Self>

impl NSData

NSDataBase64Encoding

pub unsafe fn initWithBase64EncodedString_options( this: Allocated<Self>, base64_string: &NSString, options: NSDataBase64DecodingOptions ) -> Option<Retained<Self>>

Available on crate feature NSString only.

pub unsafe fn base64EncodedStringWithOptions( &self, options: NSDataBase64EncodingOptions ) -> Retained<NSString>

Available on crate feature NSString only.

pub unsafe fn initWithBase64EncodedData_options( this: Allocated<Self>, base64_data: &NSData, options: NSDataBase64DecodingOptions ) -> Option<Retained<Self>>

pub unsafe fn base64EncodedDataWithOptions( &self, options: NSDataBase64EncodingOptions ) -> Retained<NSData>

impl NSData

NSDataCompression

pub unsafe fn decompressedDataUsingAlgorithm_error( &self, algorithm: NSDataCompressionAlgorithm ) -> Result<Retained<Self>, Retained<NSError>>

Available on crate feature NSError only.

pub unsafe fn compressedDataUsingAlgorithm_error( &self, algorithm: NSDataCompressionAlgorithm ) -> Result<Retained<Self>, Retained<NSError>>

Available on crate feature NSError only.

impl NSData

NSDeprecated

pub unsafe fn getBytes(&self, buffer: NonNull<c_void>)

👎Deprecated: This method is unsafe because it could potentially cause buffer overruns. Use -getBytes:length: instead.

pub unsafe fn dataWithContentsOfMappedFile( path: &NSString ) -> Option<Retained<AnyObject>>

👎Deprecated: Use +dataWithContentsOfURL:options:error: and NSDataReadingMappedIfSafe or NSDataReadingMappedAlways instead.

Available on crate feature NSString only.

pub unsafe fn initWithContentsOfMappedFile( this: Allocated<Self>, path: &NSString ) -> Option<Retained<Self>>

👎Deprecated: Use -initWithContentsOfURL:options:error: and NSDataReadingMappedIfSafe or NSDataReadingMappedAlways instead.

Available on crate feature NSString only.

pub unsafe fn initWithBase64Encoding( this: Allocated<Self>, base64_string: &NSString ) -> Option<Retained<Self>>

👎Deprecated: Use initWithBase64EncodedString:options: instead

Available on crate feature NSString only.

pub unsafe fn base64Encoding(&self) -> Retained<NSString>

👎Deprecated: Use base64EncodedStringWithOptions: instead

Available on crate feature NSString only.

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

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

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

Safety

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

See Ivar::load_ptr for details surrounding this.

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

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load_mut instead.

Use Ivar::load_mut instead.

Safety

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

See Ivar::load_ptr for details surrounding this.

Trait Implementations

impl AsMut<AnyObject> for NSData

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

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

impl AsMut<NSData> for NSData

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

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

impl AsMut<NSData> for NSMutableData

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

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

impl AsMut<NSData> for NSPurgeableData

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

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

impl AsMut<NSObject> for NSData

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

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

impl AsRef<[u8]> for NSData

fn as_ref(&self) -> &[u8]

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

impl AsRef<AnyObject> for NSData

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSData> for NSData

fn as_ref(&self) -> &Self

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

impl AsRef<NSData> for NSMutableData

fn as_ref(&self) -> &NSData

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

impl AsRef<NSData> for NSPurgeableData

fn as_ref(&self) -> &NSData

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

impl AsRef<NSObject> for NSData

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for NSData

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSData> for NSMutableData

fn borrow(&self) -> &NSData

Immutably borrows from an owned value.

impl Borrow<NSData> for NSPurgeableData

fn borrow(&self) -> &NSData

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSData

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl BorrowMut<AnyObject> for NSData

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

Mutably borrows from an owned value.

impl BorrowMut<NSData> for NSMutableData

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

Mutably borrows from an owned value.

impl BorrowMut<NSData> for NSPurgeableData

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

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for NSData

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

Mutably borrows from an owned value.

impl ClassType for NSData

type Super = NSObject

The superclass of this class.

type Mutability = ImmutableWithMutableSubclass<NSMutableData>

Whether the type is mutable or immutable.

const NAME: &'static str = "NSData"

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 alloc() -> Allocated<Self>

where Self: Sized + IsAllocableAnyThread,

Allocate a new instance of the class.

impl Debug for NSData

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

Formats the value using the given formatter.

impl DefaultRetained for NSData

fn default_id() -> Retained<Self>

The default Retained for a type.

fn default_retained() -> Retained<Self>

The default Retained for a type.

impl Deref for NSData

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for NSData

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

Mutably dereferences the value.

impl Hash for NSData

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<I: SliceIndex<[u8]>> Index<I> for NSData

type Output = <I as SliceIndex<[u8]>>::Output

The returned type after indexing.

fn index(&self, index: I) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a> IntoIterator for &'a NSData

type Item = &'a u8

The type of the elements being iterated over.

type IntoIter = Iter<'a, u8>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl NSCoding for NSData

Available on crate feature NSObject only.

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

Available on crate feature NSCoder only.

unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder ) -> Option<Retained<Self>>

where Self: Sized + Message,

Available on crate feature NSCoder only.

impl NSCopying for NSData

Available on crate feature NSObject only.

fn copy(&self) -> Retained<Self::Immutable>

where Self: Sized + Message + CounterpartOrSelf,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Immutable>

where Self: Sized + Message + CounterpartOrSelf,

Available on crate feature NSZone only.

Returns a new instance that’s a copy of the receiver.

impl NSMutableCopying for NSData

Available on crate feature NSObject only.

fn mutableCopy(&self) -> Retained<Self::Mutable>

where Self: Sized + Message + CounterpartOrSelf,

Returns a new instance that’s a mutable copy of the receiver.

unsafe fn mutableCopyWithZone( &self, zone: *mut NSZone ) -> Retained<Self::Mutable>

where Self: Sized + Message + CounterpartOrSelf,

Available on crate feature NSZone only.

Returns a new instance that’s a mutable copy of the receiver.

impl NSObjectProtocol for NSData

fn isEqual(&self, other: &AnyObject) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

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

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl NSSecureCoding for NSData

Available on crate feature NSObject only.

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for NSData

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

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

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

impl RetainedFromIterator<u8> for NSData

Available on crate feature block2 only.

fn id_from_iter<I: IntoIterator<Item = u8>>(iter: I) -> Retained<Self>

Creates an Retained from an iterator.

fn retained_from_iter<I>(iter: I) -> Retained<Self>

where I: IntoIterator<Item = T>,

Creates an Retained from an iterator.

impl ToOwned for NSData

Available on crate feature NSObject only.

type Owned = Retained<NSData>

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl Eq for NSData

impl Message for NSData

impl RefUnwindSafe for NSData

impl Send for NSData

impl StructuralPartialEq for NSData

impl Sync for NSData

impl UnwindSafe for NSData