Struct NSValue

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

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

Available on crate features Foundation and Foundation_NSValue only.

Implementations

impl NSValue

Creation methods.

pub fn new<T: 'static + Copy + Encode>(value: T) -> Id<Self>

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

Create a new NSValue containing the given type.

Be careful when using this since you may accidentally pass a reference when you wanted to pass a concrete type instead.

Examples

Create an NSValue containing an NSPoint.

use icrate::Foundation::{NSPoint, NSValue};

let val = NSValue::new::<NSPoint>(NSPoint::new(1.0, 1.0));

impl NSValue

Getter methods.

pub unsafe fn get<T: 'static + Copy + Encode>(&self) -> T

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

Retrieve the data contained in the NSValue.

Note that this is broken on GNUStep for some types, see gnustep/libs-base#216.

Safety

The type of T must be what the NSValue actually stores, and any safety invariants that the value has must be upheld.

Note that it may be enough, although is not always, to check whether contains_encoding returns true. For example, NonNull<T> have the same encoding as *const T, but NonNull<T> is clearly not safe to return from this function even if you’ve checked the encoding beforehand.

Examples

Store a pointer in NSValue, and retrieve it again afterwards.

use std::ffi::c_void;
use std::ptr;
use icrate::Foundation::NSValue;

let val = NSValue::new::<*const c_void>(ptr::null());
// SAFETY: The value was just created with a pointer
let res = unsafe { val.get::<*const c_void>() };
assert!(res.is_null());

pub fn get_range(&self) -> Option<NSRange>

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

pub fn get_point(&self) -> Option<NSPoint>

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

pub fn get_size(&self) -> Option<NSSize>

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

pub fn get_rect(&self) -> Option<NSRect>

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

pub fn encoding(&self) -> Option<&str>

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

pub fn contains_encoding<T: 'static + Copy + Encode>(&self) -> bool

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

impl NSValue

NSValueGeometryExtensions

pub unsafe fn valueWithPoint(point: NSPoint) -> Id<NSValue>

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

pub unsafe fn valueWithSize(size: NSSize) -> Id<NSValue>

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

pub unsafe fn valueWithRect(rect: NSRect) -> Id<NSValue>

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

pub unsafe fn valueWithEdgeInsets(insets: NSEdgeInsets) -> Id<NSValue>

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

pub unsafe fn pointValue(&self) -> NSPoint

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

pub unsafe fn sizeValue(&self) -> NSSize

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

pub unsafe fn rectValue(&self) -> NSRect

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

pub unsafe fn edgeInsetsValue(&self) -> NSEdgeInsets

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

impl NSValue

NSValueRangeExtensions

pub unsafe fn valueWithRange(range: NSRange) -> Id<NSValue>

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

pub unsafe fn rangeValue(&self) -> NSRange

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

impl NSValue

pub unsafe fn getValue_size(&self, value: NonNull<c_void>, size: NSUInteger)

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

pub fn objCType(&self) -> NonNull<c_char>

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

pub unsafe fn initWithBytes_objCType( this: Allocated<Self>, value: NonNull<c_void>, type: NonNull<c_char>, ) -> Id<Self>

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

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

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

Available on crate feature Foundation_NSCoder only.

impl NSValue

NSValueCreation

pub unsafe fn valueWithBytes_objCType( value: NonNull<c_void>, type: NonNull<c_char>, ) -> Id<NSValue>

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

pub unsafe fn value_withObjCType( value: NonNull<c_void>, type: NonNull<c_char>, ) -> Id<NSValue>

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

impl NSValue

NSValueExtensionMethods

pub unsafe fn valueWithNonretainedObject( an_object: Option<&AnyObject>, ) -> Id<NSValue>

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

pub unsafe fn nonretainedObjectValue(&self) -> Option<Id<AnyObject>>

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

pub unsafe fn valueWithPointer(pointer: *mut c_void) -> Id<NSValue>

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

pub unsafe fn pointerValue(&self) -> *mut c_void

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

pub fn isEqualToValue(&self, value: &NSValue) -> bool

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

impl NSValue

NSDeprecated

pub unsafe fn getValue(&self, value: NonNull<c_void>)

👎Deprecated

impl NSValue

NSValueMapKitGeometryExtensions

pub unsafe fn valueWithMKCoordinate( coordinate: CLLocationCoordinate2D, ) -> Id<NSValue>

👎Deprecated: icrate::MapKit has been moved to objc2-map-kit

Available on crate feature MapKit only.

pub unsafe fn valueWithMKCoordinateSpan(span: MKCoordinateSpan) -> Id<NSValue>

👎Deprecated: icrate::MapKit has been moved to objc2-map-kit

Available on crate feature MapKit only.

pub unsafe fn MKCoordinateValue(&self) -> CLLocationCoordinate2D

👎Deprecated: icrate::MapKit has been moved to objc2-map-kit

Available on crate feature MapKit only.

pub unsafe fn MKCoordinateSpanValue(&self) -> MKCoordinateSpan

👎Deprecated: icrate::MapKit has been moved to objc2-map-kit

Available on crate feature MapKit only.

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Available on crate feature AuthenticationServices only.

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.

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 unsafe fn get_mut_ivar<T>(&mut self, name: &str) -> &mut T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load_mut instead.

Use Ivar::load_mut 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.

Trait Implementations

impl AsMut<AnyObject> for NSValue

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

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

impl AsMut<NSObject> for NSValue

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

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

impl AsMut<NSValue> for NSDecimalNumber

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

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

impl AsMut<NSValue> for NSNumber

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

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

impl AsMut<NSValue> for NSValue

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

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

impl AsRef<AnyObject> for NSValue

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for NSValue

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSValue> for NSDecimalNumber

fn as_ref(&self) -> &NSValue

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

impl AsRef<NSValue> for NSNumber

fn as_ref(&self) -> &NSValue

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

impl AsRef<NSValue> for NSValue

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for NSValue

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSValue

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSValue> for NSDecimalNumber

fn borrow(&self) -> &NSValue

Immutably borrows from an owned value.

impl Borrow<NSValue> for NSNumber

fn borrow(&self) -> &NSValue

Immutably borrows from an owned value.

impl BorrowMut<AnyObject> for NSValue

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

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for NSValue

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

Mutably borrows from an owned value.

impl BorrowMut<NSValue> for NSDecimalNumber

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

Mutably borrows from an owned value.

impl BorrowMut<NSValue> for NSNumber

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

Mutably borrows from an owned value.

impl ClassType for NSValue

const NAME: &'static str = "NSValue"

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

type Super = NSObject

The superclass of this class.

type Mutability = Immutable

Whether the type is mutable or immutable.

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.

fn as_super_mut(&mut self) -> &mut Self::Super

Get a mutable reference to the superclass.

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

where Self: IsRetainable + Sized,

Increment the reference count of the receiver.

fn alloc() -> Allocated<Self>

where Self: Sized + IsAllocableAnyThread,

Allocate a new instance of the class.

impl Debug for NSValue

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

Formats the value using the given formatter.

impl Deref for NSValue

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for NSValue

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

Mutably dereferences the value.

impl Hash for NSValue

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 NSCoding for NSValue

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

where Self: Sized + Message,

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

Available on crate feature Foundation_NSCoder only.

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

where Self: Sized + Message,

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

Available on crate feature Foundation_NSCoder only.

impl NSCopying for NSValue

fn copy(&self) -> Id<Self::Immutable>

where Self: Sized + Message + CounterpartOrSelf,

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Id<Self::Immutable>

where Self: Sized + Message + CounterpartOrSelf,

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for NSValue

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

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) -> Id<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Id<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 NSValue

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

👎Deprecated: icrate::Foundation has been moved to objc2-foundation

impl PartialEq for NSValue

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 NSValue

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

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

impl ToOwned for NSValue

type Owned = Id<NSValue>

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