Struct NSNumber 

#[repr(C)]
pub struct NSNumber(/* private fields */);

An object wrapper for primitive scalar numeric values.

There are static instances which make using certain numbers much faster.

See documentation.

Implementations

impl NSNumber

Scalar constructors.

pub fn from_bool(value: bool) -> Arc<Self>

Creates a number object containing a boolean.

See documentation.

pub fn from_float(value: c_float) -> Arc<Self>

Creates a number object from a C float.

See documentation

pub fn from_double(value: c_double) -> Arc<Self>

Creates a number object from a C double.

See documentation

pub fn from_char(value: c_char) -> Arc<Self>

Creates a number object from a C char.

See documentation

pub fn from_short(value: c_short) -> Arc<Self>

Creates a number object from a C short.

See documentation

pub fn from_int(value: c_int) -> Arc<Self>

Creates a number object from a C int.

See documentation

pub fn from_long(value: c_long) -> Arc<Self>

Creates a number object from a C long.

See documentation

pub fn from_longlong(value: c_longlong) -> Arc<Self>

Creates a number object from a C long long.

See documentation

pub fn from_integer(value: NSInteger) -> Arc<Self>

Creates a number object from an Objective-C integer.

See documentation

pub fn from_unsigned_char(value: c_uchar) -> Arc<Self>

Creates a number object from a C unsigned char.

See documentation

pub fn from_unsigned_short(value: c_ushort) -> Arc<Self>

Creates a number object from a C unsigned short.

See documentation

pub fn from_unsigned_int(value: c_uint) -> Arc<Self>

Creates a number object from a C unsigned int.

See documentation

pub fn from_unsigned_long(value: c_ulong) -> Arc<Self>

Creates a number object from a C unsigned long.

See documentation

pub fn from_unsigned_longlong(value: c_ulonglong) -> Arc<Self>

Creates a number object from a C unsigned long long.

See documentation

pub fn from_unsigned_integer(value: NSUInteger) -> Arc<Self>

Creates a number object from a Objective-C unsigned integer.

See documentation

impl NSNumber

Static instances.

Use these number references over corresponding constructors for better performance.

pub fn no() -> &'static NSNumber

Returns a reference to the equivalent of @NO.

This internally references kCFBooleanFalse.

pub fn yes() -> &'static NSNumber

Returns a reference to the equivalent of @YES.

This internally references kCFBooleanTrue.

pub fn nan() -> &'static NSNumber

Returns a reference to a NaN (Not a Number) value.

This internally references kCFNumberNaN.

pub fn infinity() -> &'static NSNumber

Returns a reference to the infinity (∞) value.

This internally references kCFNumberPositiveInfinity.

pub fn neg_infinity() -> &'static NSNumber

Returns a reference to the negative infinity (−∞) value.

This internally references kCFNumberNegativeInfinity.

impl NSNumber

Instance operations.

pub fn compare(&self, other: &NSNumber) -> NSComparisonResult

Returns an NSComparisonResult value that indicates whether the number object’s value is greater than, equal to, or less than a given number.

This method follows the standard C rules for type conversion. For example, if you compare an NSNumber object that has an integer value with an NSNumber object that has a floating point value, the integer value is converted to a floating-point value for comparison.

See documentation

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

Returns the number object’s value expressed as a human-readable string.

See documentation

pub fn description_with_locale<'l, L>( &self, locale: Option<&L>, ) -> Arc<NSString<'_>>

where L: AsRef<ObjCObject<'l>>,

Returns a string that represents the contents of the number object for a given locale.

See documentation

impl NSNumber

Accessing numeric values.

pub fn bool_value(&self) -> bool

Returns the number object’s value expressed as boolean, converted as necessary.

See documentation.

pub fn float_value(&self) -> c_float

Returns the number object’s value expressed as a C float, converted as necessary.

See documentation.

pub fn double_value(&self) -> c_double

Returns the number object’s value expressed as a C double, converted as necessary.

See documentation.

pub fn char_value(&self) -> c_char

Returns the number object’s value expressed as a C char, converted as necessary.

See documentation.

pub fn short_value(&self) -> c_short

Returns the number object’s value expressed as a C short, converted as necessary.

See documentation.

pub fn int_value(&self) -> c_int

Returns the number object’s value expressed as a C int, converted as necessary.

See documentation.

pub fn long_value(&self) -> c_long

Returns the number object’s value expressed as a C long, converted as necessary.

See documentation.

pub fn longlong_value(&self) -> c_longlong

Returns the number object’s value expressed as a C long long, converted as necessary.

See documentation.

pub fn integer_value(&self) -> NSInteger

Returns the number object’s value expressed as an Objective-C integer, converted as necessary.

See documentation.

pub fn unsigned_char_value(&self) -> c_uchar

Returns the number object’s value expressed as a C unsigned char, converted as necessary.

See documentation.

pub fn unsigned_short_value(&self) -> c_ushort

Returns the number object’s value expressed as a C unsigned short, converted as necessary.

See documentation.

pub fn unsigned_int_value(&self) -> c_uint

Returns the number object’s value expressed as a C unsigned int, converted as necessary.

See documentation.

pub fn unsigned_long_value(&self) -> c_ulong

Returns the number object’s value expressed as a C unsigned long, converted as necessary.

See documentation.

pub fn unsigned_longlong_value(&self) -> c_ulonglong

Returns the number object’s value expressed as a C unsigned long long, converted as necessary.

See documentation.

pub fn unsigned_integer_value(&self) -> NSUInteger

Returns the number object’s value expressed as an Objective-C unsigned integer, converted as necessary.

See documentation.

Methods from Deref<Target = NSValue>

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.

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

pub fn range_value(&self) -> NSRange

Returns the value as an NSRange.

See documentation.

pub fn point_value(&self) -> NSPoint

Returns the value as an NSPoint.

See documentation.

pub fn size_value(&self) -> NSSize

Returns the value as an NSSize.

See documentation.

pub fn rect_value(&self) -> NSRect

Returns the value as an NSRect.

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<CFNumber> for NSNumber

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

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

impl AsMut<NSNumber> for CFNumber

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

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

impl AsMut<NSNumber> for NSNumber

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

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

impl<T> AsMut<T> for NSNumber

where NSValue: AsMut<T>,

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

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

impl AsRef<CFNumber> for NSNumber

fn as_ref(&self) -> &CFNumber

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

impl AsRef<NSNumber> for CFBoolean

fn as_ref(&self) -> &NSNumber

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

impl AsRef<NSNumber> for CFNumber

fn as_ref(&self) -> &NSNumber

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

impl AsRef<NSNumber> for NSNumber

fn as_ref(&self) -> &Self

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

impl<T> AsRef<T> for NSNumber

where NSValue: AsRef<T>,

fn as_ref(&self) -> &T

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

impl ClassType<'static> for NSNumber

fn class() -> &'static Class

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

impl Debug for NSNumber

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

Formats the value using the given formatter.

impl Deref for NSNumber

type Target = NSValue

The resulting type after dereferencing.

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

Dereferences the value.

impl Display for NSNumber

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

Formats the value using the given formatter.

impl From<&NSNumber> for Arc<NSString<'_>>

fn from(number: &NSNumber) -> Self

Converts to this type from the input type.

impl ObjectType<'static> for NSNumber

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.

impl ObjectType for NSNumber

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 Ord for NSNumber

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

Restrict a value to a certain interval.

impl PartialEq for NSNumber

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 PartialOrd for NSNumber

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for NSNumber