Struct objc2::mutability::MutableWithImmutableSuperclass

pub struct MutableWithImmutableSuperclass<IS: ?Sized> { /* private fields */ }

Marker type for mutable classes that have a immutable counterpart.

This is effectively the same as Mutable, except for the immutable counterpart being be specified as the type parameter IS to allow NSCopying and NSMutableCopying to return the correct type.

Functionality that is provided with this:

• IsAllocableAnyThread -> ClassType::alloc.
• IsAllowedMutable.
• IsMutable -> impl DerefMut for Retained.
• You are allowed to hand out pointers / references to an instance’s internal data, since you know such data will never be mutated without the borrowchecker catching it.

Example

unsafe impl ClassType for NSData {
    type Super = NSObject;
    type Mutability = ImmutableWithMutableSubclass<NSMutableData>;
    // ...
}

unsafe impl ClassType for NSMutableData {
    type Super = NSData;
    type Mutability = MutableWithImmutableSubclass<NSData>;
    // ...
}

Trait Implementations

impl<IS: Clone + ?Sized> Clone for MutableWithImmutableSuperclass<IS>

fn clone(&self) -> MutableWithImmutableSuperclass<IS>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<IS: Debug + ?Sized> Debug for MutableWithImmutableSuperclass<IS>

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

Formats the value using the given formatter.

impl<IS: Hash + ?Sized> Hash for MutableWithImmutableSuperclass<IS>

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<IS: Ord + ?Sized> Ord for MutableWithImmutableSuperclass<IS>

fn cmp(&self, other: &MutableWithImmutableSuperclass<IS>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<IS: PartialEq + ?Sized> PartialEq for MutableWithImmutableSuperclass<IS>

fn eq(&self, other: &MutableWithImmutableSuperclass<IS>) -> 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<IS: PartialOrd + ?Sized> PartialOrd for MutableWithImmutableSuperclass<IS>

fn partial_cmp( &self, other: &MutableWithImmutableSuperclass<IS> ) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<IS: Copy + ?Sized> Copy for MutableWithImmutableSuperclass<IS>

impl<IS: Eq + ?Sized> Eq for MutableWithImmutableSuperclass<IS>

impl<IS: ?Sized> Mutability for MutableWithImmutableSuperclass<IS>

impl<IS: ?Sized> StructuralPartialEq for MutableWithImmutableSuperclass<IS>