Struct objc2::foundation::NSMutableData

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

A dynamic byte buffer in memory.

This is the Objective-C equivalent of a Vec containing u8.

See Apple’s documentation.

Implementations

impl NSMutableData

Creation methods

pub fn new() -> Id<Self, Owned>

pub fn with_bytes(bytes: &[u8]) -> Id<Self, Owned>

pub fn from_data(data: &NSData) -> Id<Self, Owned>

pub fn with_capacity(capacity: usize) -> Id<Self, Owned>

impl NSMutableData

Mutation methods

pub fn set_len(&mut self, len: usize)

Expands with zeroes, or truncates the buffer.

pub fn bytes_mut(&mut self) -> &mut [u8]

pub fn extend_from_slice(&mut self, bytes: &[u8])

pub fn push(&mut self, byte: u8)

pub fn replace_range(&mut self, range: Range<usize>, bytes: &[u8])

pub fn set_bytes(&mut self, bytes: &[u8])

Methods from Deref<Target = NSData>

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

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

Methods from Deref<Target = NSObject>

pub fn is_kind_of<T: ClassType>(&self) -> bool

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

See Apple’s documentation for more details on what you may (and what you may not) do with this information.

Methods from Deref<Target = Object>

pub fn class(&self) -> &Class

Dynamically find the class of this object.

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

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: Encode>(&self, name: &str) -> &T

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

See Object::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 Object::ivar_mut (since that takes &mut self).

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

👎Deprecated: Use Object::ivar instead.

Use Object::ivar instead.

Safety

See Object::ivar.

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

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

See Object::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: Encode>(&mut self, name: &str) -> &mut T

👎Deprecated: Use Object::ivar_mut instead.

Use Object::ivar_mut instead.

Safety

Same as Object::ivar_mut.

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

Sets the value of the ivar with the given name.

This is just a helpful shorthand for Object::ivar_mut, see that for more information.

Safety

Same as Object::ivar_mut.

Trait Implementations

impl AsMut<[u8]> for NSMutableData

fn as_mut(&mut self) -> &mut [u8]

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<NSMutableData> for NSMutableData

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

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

impl AsMut<NSObject> for NSMutableData

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

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

impl AsMut<Object> for NSMutableData

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

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

impl AsRef<[u8]> for NSMutableData

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

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<NSMutableData> for NSMutableData

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for NSMutableData

fn as_ref(&self) -> &NSObject

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

impl AsRef<Object> for NSMutableData

fn as_ref(&self) -> &Object

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

impl Borrow<NSData> for NSMutableData

fn borrow(&self) -> &NSData

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSMutableData

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<Object> for NSMutableData

fn borrow(&self) -> &Object

Immutably 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<NSObject> for NSMutableData

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

Mutably borrows from an owned value.

impl BorrowMut<Object> for NSMutableData

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

Mutably borrows from an owned value.

impl ClassType for NSMutableData

type Super = NSData

The superclass of this class.

const NAME: &'static str = _

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

fn class() -> &'static Class

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.

impl Debug for NSMutableData

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

Formats the value using the given formatter.

impl DefaultId for NSMutableData

type Ownership = Owned

Indicates whether the default value is mutable or immutable.

fn default_id() -> Id<Self, Self::Ownership>

The default Id for a type.

impl Deref for NSMutableData

type Target = NSData

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for NSMutableData

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

Mutably dereferences the value.

impl<'a> Extend<&'a u8> for NSMutableData

fn extend<T: IntoIterator<Item = &'a u8>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<u8> for NSMutableData

fn extend<T: IntoIterator<Item = u8>>(&mut self, iter: T)

You should use extend_from_slice whenever possible, it is more performant.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Hash for NSMutableData

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 NSMutableData

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<I: SliceIndex<[u8]>> IndexMut<I> for NSMutableData

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

Performs the mutable indexing (container[index]) operation.

impl<'a> IntoIterator for &'a NSMutableData

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<'a> IntoIterator for &'a mut NSMutableData

type Item = &'a mut u8

The type of the elements being iterated over.

type IntoIter = IterMut<'a, u8>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl NSCopying for NSMutableData

type Ownership = Shared

Indicates whether the type is mutable or immutable.

type Output = NSData

The output type.

fn copy(&self) -> Id<Self::Output, Self::Ownership>

impl NSMutableCopying for NSMutableData

type Output = NSMutableData

TODO

fn mutable_copy(&self) -> Id<Self::Output, Owned>

impl PartialEq<NSMutableData> for NSMutableData

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

const ENCODING_REF: Encoding = <NSData as crate::RefEncode>::ENCODING_REF

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

impl ToOwned for NSMutableData

type Owned = Id<NSMutableData, Owned>

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 Write for NSMutableData

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn write_all(&mut self, buf: &[u8]) -> Result<()>

Attempts to write an entire buffer into this writer.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Selfwhere Self: Sized,

Creates a “by reference” adapter for this instance of Write.

impl Eq for NSMutableData

impl Message for NSMutableData

impl StructuralEq for NSMutableData

impl StructuralPartialEq for NSMutableData