Struct fruity__bbqsrc::foundation::NSValue

#[repr(C)]
pub struct NSValue(_);

A simple container for a single C or Objective-C data item.

See documentation.

Implementations

impl NSValue

Arbitrary values.

pub unsafe fn from_bytes(
    value: *const c_void,
    objc_type: *const c_char
) -> Arc<Self>

Creates a value object containing the specified value, interpreted with the specified Objective-C type.

See documentation.

pub fn objc_type(&self) -> *const c_char

Returns a pointer to a C string containing the Objective-C type of this object’s value.

See documentation.

pub fn objc_type_cstr(&self) -> &CStr

Returns objc_type as a C string reference.

pub unsafe fn write_value(&self, value: *mut c_void, size: NSUInteger)

Writes size bytes of the value to a pointer.

See documentation.

Exception Handling

If size is the wrong number of bytes, an NSInvalidArgumentException is thrown.

pub fn write_value_slice(&self, value: &mut [u8])

Writes the value to a slice buffer.

Exception Handling

If value is the wrong number of bytes, an NSInvalidArgumentException is thrown.

pub unsafe fn transmute_value<T>(&self) -> T

Returns the value as some generic type.

Exception Handling

If the type is the wrong size, an NSInvalidArgumentException is thrown.

Safety

The value must have a valid memory representation for the return type.

impl NSValue

Pointer values.

pub fn from_ptr(ptr: *const c_void) -> Arc<Self>

Creates a value object containing the specified pointer.

See documentation.

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

Returns the value as an untyped pointer.

The value as a pointer to void. If the value object was not created to hold a pointer-sized data item, the result is undefined.

See documentation.

pub fn from_nonretained_object(obj: *mut ObjCObject<'_>) -> Arc<Self>

Creates a value object containing the specified pointer.

This method is useful if you want to add an object to a collection but don’t want the collection to create a strong reference to it.

See documentation.

pub fn nonretained_object_value(&self) -> *mut ObjCObject<'_>

Returns the value as a non-retained pointer to an object.

If the value was not created to hold a pointer-sized data item, the result is undefined.

See documentation.

impl NSValue

Range values.

pub fn from_range(value: NSRange) -> Arc<Self>

Creates a new value object containing the specified range.

See documentation.

pub fn range_value(&self) -> NSRange

Returns the value as an NSRange.

See documentation.

impl NSValue

Foundation geometry values.

pub fn from_point(value: NSPoint) -> Arc<Self>

Creates a new value object containing the specified point.

See documentation.

pub fn point_value(&self) -> NSPoint

Returns the value as an NSPoint.

See documentation.

pub fn from_size(value: NSSize) -> Arc<Self>

Creates a new value object containing the specified size.

See documentation.

pub fn size_value(&self) -> NSSize

Returns the value as an NSSize.

See documentation.

pub fn from_rect(value: NSRect) -> Arc<Self>

Creates a new value object containing the specified rectangle.

See documentation.

pub fn rect_value(&self) -> NSRect

Returns the value as an NSRect.

See documentation.

pub fn from_edge_insets(value: NSEdgeInsets) -> Arc<Self>

Creates a new value object containing the specified edge insets.

See documentation.

pub fn edge_insets_value(&self) -> NSEdgeInsets

Returns the value as an NSEdgeInsets.

See documentation.

Methods from Deref<Target = NSObject<'static>>

pub fn retain_count(&self) -> usize

Returns this object’s reference count.

This method is only useful for debugging certain objects.

See documentation.

pub fn responds_to_selector(&self, selector: Sel) -> bool

Returns true if this object implements or inherits a method that can respond to a specified message.

See documentation.

pub fn is_kind_of_class(&self, class: &Class) -> bool

Returns true if this object is an instance or subclass of class.

See documentation

pub fn is_member_of_class(&self, class: &Class) -> bool

Returns true if this object is an instance of class.

See documentation

pub fn hash(&self) -> NSUInteger

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

See documentation.

pub fn copy(&self) -> Arc<Self>

Returns a copy of this object using NSCopying.

See documentation.

pub fn mutable_copy(&self) -> Arc<Self>

Returns a copy of this object using NSMutableCopying.

See documentation.

pub fn description(&self) -> Arc<NSString<'static>>

Returns a string that describes the contents of this object.

See documentation

pub fn debug_description(&self) -> Arc<NSString<'static>>

Returns a string that describes the contents of the receiver for presentation in the debugger.

See documentation

Trait Implementations

impl AsMut<NSValue> for NSValue

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

Performs the conversion.

impl<T> AsMut<T> for NSValue where
    NSObject<'static>: AsMut<T>, 

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

Performs the conversion.

impl AsRef<NSValue> for NSValue

fn as_ref(&self) -> &Self

Performs the conversion.

impl<T> AsRef<T> for NSValue where
    NSObject<'static>: AsRef<T>, 

fn as_ref(&self) -> &T

Performs the conversion.

impl ClassType<'static> for NSValue

fn class() -> &'static Class

Returns the Objective-C class that can be used to instantiate a new instance of Self.

impl Deref for NSValue

type Target = NSObject<'static>

The resulting type after dereferencing.

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

Dereferences the value.

impl ObjectType for NSValue

fn retain(obj: &Self) -> Arc<Self>

Increments the object’s retain count and returns a smart pointer that automatically calls release on Drop.

unsafe fn release(obj: NonNull<Self>)

Decrements the object’s retain count.

impl ObjectType<'static> for NSValue

fn as_objc_object(&self) -> &ObjCObject<'data>

Casts self into a type-erased Objective-C object.

fn class<'s>(&'s self) -> &'s Class where
    'data: 's, 

Returns the class that this object is an instance of.