Struct NSPurgeableData

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

Available on crate feature NSData only.

************** Purgeable Data ***************

See also Apple’s documentation

Implementations

impl NSPurgeableData

Methods declared on superclass NSObject.

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

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

Methods from Deref<Target = NSMutableData>

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

A mutable view of the bytes in the data.

Safety

No methods on the NSMutableData may be called while the returned slice is alive.

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

pub fn push(&self, byte: u8)

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

Available on crate feature NSRange only.

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

Available on crate feature NSRange only.

pub fn setLength(&self, length: NSUInteger)

Setter for [length][Self::length].

pub unsafe fn appendBytes_length( &self, bytes: NonNull<c_void>, length: NSUInteger, )

pub unsafe fn appendData(&self, other: &NSData)

pub unsafe fn increaseLengthBy(&self, extra_length: NSUInteger)

pub unsafe fn replaceBytesInRange_withBytes( &self, range: NSRange, bytes: NonNull<c_void>, )

Available on crate feature NSRange only.

pub unsafe fn resetBytesInRange(&self, range: NSRange)

Available on crate feature NSRange only.

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

pub unsafe fn replaceBytesInRange_withBytes_length( &self, range: NSRange, replacement_bytes: *const c_void, replacement_length: NSUInteger, )

Available on crate feature NSRange only.

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

Available on crate feature NSError only.

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

Available on crate feature NSError only.

Methods from Deref<Target = NSData>

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub unsafe fn as_bytes_unchecked(&self) -> &[u8]

The bytes in the data.

Safety

The data must not be mutated while the returned slice is alive. Consider using to_vec instead if this requirement is a bit difficult to uphold.

pub fn to_vec(&self) -> Vec<u8>

Copy the contents of the data into a new Vec.

pub fn iter(&self) -> Iter<'_>

Iterate over the bytes of the data.

pub fn length(&self) -> NSUInteger

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: &DynBlock<dyn Fn(NonNull<c_void>, NSRange, NonNull<Bool>) + '_>, )

Available on crate features NSRange and block2 only.

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

Available on crate feature NSString only.

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

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.

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 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.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

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 fn downcast_ref<T>(&self) -> Option<&T>

where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AnyObject> for NSPurgeableData

fn as_ref(&self) -> &AnyObject

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

fn as_ref(&self) -> &NSMutableData

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

impl AsRef<NSObject> for NSPurgeableData

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSPurgeableData> for NSPurgeableData

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for NSPurgeableData

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSData> for NSPurgeableData

fn borrow(&self) -> &NSData

Immutably borrows from an owned value.

impl Borrow<NSMutableData> for NSPurgeableData

fn borrow(&self) -> &NSMutableData

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSPurgeableData

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSPurgeableData

const NAME: &'static str = "NSPurgeableData"

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

type Super = NSMutableData

The superclass of this class.

type ThreadKind = <<NSPurgeableData as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

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.

impl Debug for NSPurgeableData

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

Formats the value using the given formatter.

impl Deref for NSPurgeableData

type Target = NSMutableData

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSPurgeableData

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 Message for NSPurgeableData

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for NSPurgeableData

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

where Self: Sized + Message,

Available on crate features NSObject and NSCoder only.

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

where Self: Sized + Message,

Available on crate features NSObject and NSCoder only.

impl NSDiscardableContent for NSPurgeableData

unsafe fn beginContentAccess(&self) -> bool

where Self: Sized + Message,

Available on crate feature NSObject only.

unsafe fn endContentAccess(&self)

where Self: Sized + Message,

Available on crate feature NSObject only.

unsafe fn discardContentIfPossible(&self)

where Self: Sized + Message,

Available on crate feature NSObject only.

unsafe fn isContentDiscarded(&self) -> bool

where Self: Sized + Message,

Available on crate feature NSObject only.

impl NSObjectProtocol for NSPurgeableData

fn isEqual(&self, other: Option<&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,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

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 NSPurgeableData

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

Available on crate feature NSObject only.

impl PartialEq for NSPurgeableData

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for NSPurgeableData

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

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

impl DowncastTarget for NSPurgeableData

impl Eq for NSPurgeableData