Struct NSData

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

A static byte buffer in memory.

Fields

ptr: Id<Object>

The raw pointer to the Objective-C object.

Implementations

impl NSData

pub fn data() -> Self

Creates an empty data object.

pub fn data_with_bytes_length(bytes: *const c_void, length: UInt) -> Self

Creates a data object containing a given number of bytes copied from a given buffer.

pub fn data_with_bytes_no_copy_length(bytes: *mut c_void, length: UInt) -> Self

Creates a data object that holds a given number of bytes from a given buffer.

pub fn data_with_bytes_no_copy_length_free_when_done( bytes: *mut c_void, length: UInt, b: bool, ) -> Self

Creates a data object that holds a given number of bytes from a given buffer.

pub fn data_with_data(data: NSData) -> Self

Creates a data object containing the contents of another data object.

pub fn init_with_bytes_length( &mut self, bytes: *const c_void, length: UInt, ) -> Self

where Self: Sized + FromId,

Initializes a data object filled with a given number of bytes copied from a given buffer.

pub fn init_with_bytes_no_copy_length( &mut self, bytes: *mut c_void, length: UInt, ) -> Self

where Self: Sized + FromId,

Initializes a data object filled with a given number of bytes of data from a given buffer.

pub fn init_with_bytes_no_copy_length_deallocator<F>( &mut self, bytes: *mut c_void, length: UInt, deallocator: F, ) -> Self

where Self: Sized + FromId, F: IntoConcreteBlock<(*mut c_void, UInt), Ret = ()> + 'static,

Initializes a data object filled with a given number of bytes of data from a given buffer, with a custom deallocator block.

pub fn init_with_bytes_no_copy_length_free_when_done( &mut self, bytes: *mut c_void, length: UInt, b: bool, ) -> Self

where Self: Sized + FromId,

Initializes a newly allocated data object by adding the given number of bytes from the given buffer.

pub fn init_with_data(&mut self, data: &NSData) -> Self

where Self: Sized + FromId,

Initializes a data object with the contents of another data object.

pub fn data_with_contents_of_file(path: &NSString) -> Self

Creates a data object by reading every byte from the file at a given path.

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

Creates a data object by reading every byte from the file at a given path.

pub fn data_with_contents_of_url(url: &NSURL) -> Self

Creates a data object containing the data from the location specified by a given URL.

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

Creates a data object containing the data from the location specified by a given URL.

pub fn init_with_contents_of_file(&mut self, path: &NSString) -> Self

where Self: Sized + FromId,

Initializes a data object with the content of the file at a given path.

pub fn init_with_contents_of_file_options( &mut self, path: &NSString, read_options_mask: NSDataReadingOptions, ) -> Result<Self, NSError>

where Self: Sized + FromId,

Initializes a data object with the content of the file at a given path.

pub fn init_with_contents_of_url(&mut self, url: &NSURL) -> Self

where Self: Sized + FromId,

Initializes a data object with the data from the location specified by a given URL.

pub fn init_with_contents_of_url_options( &mut self, url: &NSURL, read_options_mask: NSDataReadingOptions, ) -> Result<Self, NSError>

where Self: Sized + FromId,

Initializes a data object with the data from the location specified by a given URL.

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

Writes the data object’s bytes to the file specified by a given path.

pub fn write_to_file_options( &self, path: &NSString, write_options: NSDataWritingOptions, ) -> Result<bool, NSError>

Writes the data object’s bytes to the file specified by a given path.

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

Writes the data object’s bytes to the location specified by a given URL.

pub fn write_to_url_options( &self, url: &NSURL, write_options: NSDataWritingOptions, ) -> Result<bool, NSError>

Writes the data object’s bytes to the location specified by a given URL.

pub fn init_with_base64_encoded_data_options( &mut self, base64_data: &NSData, options: NSDataBase64DecodingOptions, ) -> Self

where Self: Sized + FromId,

Initializes a data object with the given Base64 encoded data.

pub fn init_with_base64_encoded_string_options( &mut self, base64_string: &NSString, options: NSDataBase64DecodingOptions, ) -> Self

where Self: Sized + FromId,

Initializes a data object with the given Base64 encoded string.

pub fn base64_encoded_data_with_options( &self, options: NSDataBase64EncodingOptions, ) -> NSData

Creates a Base64, UTF-8 encoded data object from the string using the given options.

pub fn base64_encoded_string_with_options( &self, options: NSDataBase64EncodingOptions, ) -> NSString

Creates a Base64 encoded string from the string using the given options.

pub fn bytes(&self) -> *const c_void

A pointer to the data object’s contents.

pub fn enumerate_byte_ranges_using_block<F>(&self, block: F)

where F: IntoConcreteBlock<(*const c_void, NSRange, *mut bool), Ret = ()> + 'static,

Enumerates each range of bytes in the data object using a block.

pub fn get_bytes_length(&self, buffer: *mut c_void, length: UInt)

Copies a number of bytes from the start of the data object into a given buffer.

pub fn get_bytes_range(&self, buffer: *mut c_void, range: NSRange)

Copies a range of bytes from the data object into a given buffer.

pub fn subdata_with_range(&self, range: NSRange) -> NSData

Returns a new data object containing the data object’s bytes that fall within the limits specified by a given range.

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

Finds and returns the range of the first occurrence of the given data, within the given range, subject to given options.

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

Returns a Boolean value indicating whether this data object is the same as another.

pub fn length(&self) -> UInt

The number of bytes contained by the data object.

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

where Self: Sized + FromId,

Returns a new data object by compressing the data object’s bytes.

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

where Self: Sized + FromId,

Returns a new data object by decompressing data object’s bytes.

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 NSData

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 NSData

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

Formats the value using the given formatter.

impl Deref for NSData

type Target = Object

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for NSData

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

Mutably dereferences the value.

impl Display for NSData

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

Formats the value using the given formatter.

impl Encode for NSData

fn encode() -> Encoding

Returns the Objective-C type encoding for Self.

impl FromId for NSData

unsafe fn from_id(ptr: id) -> Self

Returns Self representation of the object.

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 INSData for NSData

fn m_data() -> Self

where Self: Sized + FromId,

Creates an empty data object.

fn m_data_with_bytes_length(bytes: *const c_void, length: UInt) -> Self

where Self: Sized + FromId,

Creates a data object containing a given number of bytes copied from a given buffer.

fn m_data_with_bytes_no_copy_length(bytes: *mut c_void, length: UInt) -> Self

where Self: Sized + FromId,

Creates a data object that holds a given number of bytes from a given buffer.

fn m_data_with_bytes_no_copy_length_free_when_done( bytes: *mut c_void, length: UInt, b: bool, ) -> Self

where Self: Sized + FromId,

Creates a data object that holds a given number of bytes from a given buffer.

fn m_data_with_data(data: NSData) -> Self

where Self: Sized + FromId,

Creates a data object containing the contents of another data object.

fn m_init_with_bytes_length( &mut self, bytes: *const c_void, length: UInt, ) -> Self

where Self: Sized + FromId,

Initializes a data object filled with a given number of bytes copied from a given buffer.

fn m_init_with_bytes_no_copy_length( &mut self, bytes: *mut c_void, length: UInt, ) -> Self

where Self: Sized + FromId,

Initializes a data object filled with a given number of bytes of data from a given buffer.

fn m_init_with_bytes_no_copy_length_deallocator<F>( &mut self, bytes: *mut c_void, length: UInt, deallocator: F, ) -> Self

where Self: Sized + FromId, F: IntoConcreteBlock<(*mut c_void, UInt), Ret = ()> + 'static,

Initializes a data object filled with a given number of bytes of data from a given buffer, with a custom deallocator block.

fn m_init_with_bytes_no_copy_length_free_when_done( &mut self, bytes: *mut c_void, length: UInt, b: bool, ) -> Self

where Self: Sized + FromId,

Initializes a newly allocated data object by adding the given number of bytes from the given buffer.

fn m_init_with_data(&mut self, data: &NSData) -> Self

where Self: Sized + FromId,

Initializes a data object with the contents of another data object.

fn m_data_with_contents_of_file(path: &NSString) -> Self

where Self: Sized + FromId,

Creates a data object by reading every byte from the file at a given path.

fn m_data_with_contents_of_file_options( path: &NSString, read_options_mask: NSDataReadingOptions, ) -> Result<Self, NSError>

where Self: Sized + FromId,

Creates a data object by reading every byte from the file at a given path.

fn m_data_with_contents_of_url(url: &NSURL) -> Self

where Self: Sized + FromId,

Creates a data object containing the data from the location specified by a given URL.

fn m_data_with_contents_of_url_options( url: &NSURL, read_options_mask: NSDataReadingOptions, ) -> Result<Self, NSError>

where Self: Sized + FromId,

Creates a data object containing the data from the location specified by a given URL.

fn m_init_with_contents_of_file(&mut self, path: &NSString) -> Self

where Self: Sized + FromId,

Initializes a data object with the content of the file at a given path.

fn m_init_with_contents_of_file_options( &mut self, path: &NSString, read_options_mask: NSDataReadingOptions, ) -> Result<Self, NSError>

where Self: Sized + FromId,

Initializes a data object with the content of the file at a given path.

fn m_init_with_contents_of_url(&mut self, url: &NSURL) -> Self

where Self: Sized + FromId,

Initializes a data object with the data from the location specified by a given URL.

fn m_init_with_contents_of_url_options( &mut self, url: &NSURL, read_options_mask: NSDataReadingOptions, ) -> Result<Self, NSError>

where Self: Sized + FromId,

Initializes a data object with the data from the location specified by a given URL.

fn m_write_to_file_atomically( &self, path: &NSString, use_auxiliary_file: bool, ) -> bool

Writes the data object’s bytes to the file specified by a given path.

fn m_write_to_file_options( &self, path: &NSString, write_options: NSDataWritingOptions, ) -> Result<bool, NSError>

Writes the data object’s bytes to the file specified by a given path.

fn m_write_to_url_atomically(&self, url: &NSURL, atomically: bool) -> bool

Writes the data object’s bytes to the location specified by a given URL.

fn m_write_to_url_options( &self, url: &NSURL, write_options: NSDataWritingOptions, ) -> Result<bool, NSError>

Writes the data object’s bytes to the location specified by a given URL.

fn m_init_with_base64_encoded_data_options( &mut self, base64_data: &NSData, options: NSDataBase64DecodingOptions, ) -> Self

where Self: Sized + FromId,

Initializes a data object with the given Base64 encoded data.

fn m_init_with_base64_encoded_string_options( &mut self, base64_string: &NSString, options: NSDataBase64DecodingOptions, ) -> Self

where Self: Sized + FromId,

Initializes a data object with the given Base64 encoded string.

fn m_base64_encoded_data_with_options( &self, options: NSDataBase64EncodingOptions, ) -> NSData

Creates a Base64, UTF-8 encoded data object from the string using the given options.

fn m_base64_encoded_string_with_options( &self, options: NSDataBase64EncodingOptions, ) -> NSString

Creates a Base64 encoded string from the string using the given options.

fn p_bytes(&self) -> *const c_void

A pointer to the data object’s contents.

fn m_enumerate_byte_ranges_using_block<F>(&self, block: F)

where F: IntoConcreteBlock<(*const c_void, NSRange, *mut bool), Ret = ()> + 'static,

Enumerates each range of bytes in the data object using a block.

fn m_get_bytes_length(&self, buffer: *mut c_void, length: UInt)

Copies a number of bytes from the start of the data object into a given buffer.

fn m_get_bytes_range(&self, buffer: *mut c_void, range: NSRange)

Copies a range of bytes from the data object into a given buffer.

fn m_subdata_with_range(&self, range: NSRange) -> NSData

Returns a new data object containing the data object’s bytes that fall within the limits specified by a given range.

fn m_range_of_data_options_range( &self, data_to_find: &NSData, mask: NSDataSearchOptions, search_range: NSRange, ) -> NSRange

Finds and returns the range of the first occurrence of the given data, within the given range, subject to given options.

fn m_is_equal_to_data(&self, other: &NSData) -> bool

Returns a Boolean value indicating whether this data object is the same as another.

fn m_length(&self) -> UInt

The number of bytes contained by the data object.

fn m_compressed_data_using_algorithm( &self, algorithm: NSDataCompressionAlgorithm, ) -> Result<Self, NSError>

where Self: Sized + FromId,

Returns a new data object by compressing the data object’s bytes.

fn m_decompressed_data_using_algorithm( &self, algorithm: NSDataCompressionAlgorithm, ) -> Result<Self, NSError>

where Self: Sized + FromId,

Returns a new data object by decompressing data object’s bytes.

impl PNSObject for NSData

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 NSData

fn to_id(self) -> id

Returns id representation of the object.