Struct objc2::foundation::NSNumber

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

Available on crate feature foundation only.

An object wrapper for primitive scalars.

This is the Objective-C equivalant of a Rust enum containing the common scalar types i8, u8, i16, u16, i32, u32, i64, u64, f32, f64 and the two C types c_long and c_ulong.

All accessor methods are safe, though they may return unexpected results if the number was not created from said type. Consult Apple’s documentation for details.

Note that due to limitations in Objective-C type encodings, it is not possible to distinguish between an NSNumber created from bool, and one created from an i8/u8. You should use the getter methods that fit your use-case instead!

This does not implement Eq nor Ord, since it may contain a floating point value. Beware that the implementation of PartialEq and PartialOrd does not properly handle NaNs either. Compare NSNumber::encoding with Encoding::Float or Encoding::Double, and use NSNumber::as_f32 or NSNumber::as_f64 to get the desired floating point value directly.

See Apple’s documentation for more information.

Implementations

impl NSNumber

Creation methods.

pub fn new_bool(val: bool) -> Id<Self, Shared>

pub fn new_i8(val: i8) -> Id<Self, Shared>

pub fn new_u8(val: u8) -> Id<Self, Shared>

pub fn new_i16(val: i16) -> Id<Self, Shared>

pub fn new_u16(val: u16) -> Id<Self, Shared>

pub fn new_i32(val: i32) -> Id<Self, Shared>

pub fn new_u32(val: u32) -> Id<Self, Shared>

pub fn new_i64(val: i64) -> Id<Self, Shared>

pub fn new_u64(val: u64) -> Id<Self, Shared>

pub fn new_isize(val: isize) -> Id<Self, Shared>

pub fn new_usize(val: usize) -> Id<Self, Shared>

pub fn new_f32(val: f32) -> Id<Self, Shared>

pub fn new_f64(val: f64) -> Id<Self, Shared>

pub fn new_cgfloat(val: CGFloat) -> Id<Self, Shared>

impl NSNumber

Getter methods.

pub fn as_bool(&self) -> bool

pub fn as_i8(&self) -> i8

pub fn as_u8(&self) -> u8

pub fn as_i16(&self) -> i16

pub fn as_u16(&self) -> u16

pub fn as_i32(&self) -> i32

pub fn as_u32(&self) -> u32

pub fn as_i64(&self) -> i64

pub fn as_u64(&self) -> u64

pub fn as_isize(&self) -> isize

pub fn as_usize(&self) -> usize

pub fn as_f32(&self) -> f32

pub fn as_f64(&self) -> f64

pub fn as_cgfloat(&self) -> CGFloat

pub fn encoding(&self) -> Encoding

The Objective-C encoding of this NSNumber.

This is guaranteed to return one of:

• Encoding::Char
• Encoding::UChar
• Encoding::Short
• Encoding::UShort
• Encoding::Int
• Encoding::UInt
• Encoding::Long
• Encoding::ULong
• Encoding::LongLong
• Encoding::ULongLong
• Encoding::Float
• Encoding::Double

Examples

Convert an NSNumber to/from an enumeration describing the different number properties.

use objc2::Encoding;
use objc2::foundation::NSNumber;
use objc2::rc::{Id, Shared};

// Note: `bool` would convert to either `Signed` or `Unsigned`,
// depending on platform
#[derive(Copy, Clone)]
pub enum Number {
    Signed(i64),
    Unsigned(u64),
    Floating(f64),
}

impl Number {
    fn into_nsnumber(self) -> Id<NSNumber, Shared> {
        match self {
            Self::Signed(val) => NSNumber::new_i64(val),
            Self::Unsigned(val) => NSNumber::new_u64(val),
            Self::Floating(val) => NSNumber::new_f64(val),
        }
    }
}

impl From<&NSNumber> for Number {
    fn from(n: &NSNumber) -> Self {
        match n.encoding() {
            Encoding::Char
            | Encoding::Short
            | Encoding::Int
            | Encoding::Long
            | Encoding::LongLong => Self::Signed(n.as_i64()),
            Encoding::UChar
            | Encoding::UShort
            | Encoding::UInt
            | Encoding::ULong
            | Encoding::ULongLong => Self::Unsigned(n.as_u64()),
            Encoding::Float
            | Encoding::Double => Self::Floating(n.as_f64()),
            _ => unreachable!(),
        }
    }
}

Methods from Deref<Target = NSValue>

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

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, but is not always, enough to simply 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 objc2::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>

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

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

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

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

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

Methods from Deref<Target = NSObject>

pub fn is_kind_of<T: ClassType>(&self) -> bool

Check if the object is an instance of the class, or one of it’s subclasses.

See Apple’s documentation for more details on what you may (and what you may not) do with this information.

Methods from Deref<Target = Object>

pub fn class(&self) -> &Class

Dynamically find the class of this object.

pub unsafe fn ivar_ptr<T: Encode>(&self, name: &str) -> *mut T

Returns a pointer to the instance variable / ivar with the given name.

This is similar to UnsafeCell::get, see that for more information on what is and isn’t safe to do.

Usually you will have defined the instance variable yourself with ClassBuilder::add_ivar, the type of the ivar T must match the type used in that.

Attempting to access or modify private implementation details of a class that you do no control using this is not supported, and may invoke undefined behaviour.

Library implementors are strongly encouraged to expose a safe interface to the ivar.

Panics

May panic if the object has no ivar with the given name. May also panic if the type encoding of the ivar differs from the type encoding of T.

This should purely seen as help while debugging and is not guaranteed (e.g. it may be disabled when debug_assertions are off).

Safety

The object must have an instance variable with the given name, and it must be of type T. Any invariants that the object have assumed about the value of the instance variable must not be violated.

No thread syncronization is done on accesses to the variable, so you must ensure that any access to the returned pointer do not cause data races, and that Rust’s mutability rules are not otherwise violated.

pub unsafe fn ivar<T: Encode>(&self, name: &str) -> &T

Returns a reference to the instance variable with the given name.

See Object::ivar_ptr for more information, including on when this panics.

Safety

The object must have an instance variable with the given name, and it must be of type T.

No thread syncronization is done, so you must ensure that no other thread is concurrently mutating the variable. This requirement can be considered upheld if all mutation happens through Object::ivar_mut (since that takes &mut self).

pub unsafe fn get_ivar<T: Encode>(&self, name: &str) -> &T

👎Deprecated:

Use Object::ivar instead.

Use Object::ivar instead.

Safety

See Object::ivar.

pub unsafe fn ivar_mut<T: Encode>(&mut self, name: &str) -> &mut T

Returns a mutable reference to the ivar with the given name.

See Object::ivar_ptr for more information, including on when this panics.

Safety

The object must have an instance variable with the given name, and it must be of type T.

This access happens through &mut self, which means we know it to be the only reference, hence you do not need to do any work to ensure that data races do not happen.

pub unsafe fn get_mut_ivar<T: Encode>(&mut self, name: &str) -> &mut T

👎Deprecated:

Use Object::ivar_mut instead.

Use Object::ivar_mut instead.

Safety

Same as Object::ivar_mut.

pub unsafe fn set_ivar<T: Encode>(&mut self, name: &str, value: T)

Sets the value of the ivar with the given name.

This is just a helpful shorthand for Object::ivar_mut, see that for more information.

Safety

Same as Object::ivar_mut.

Trait Implementations

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 AsMut<NSObject> for NSNumber

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

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

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

Converts this type into a mutable 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 AsRef<NSObject> for NSNumber

fn as_ref(&self) -> &NSObject

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

fn as_ref(&self) -> &Object

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

impl Borrow<NSObject> for NSNumber

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSValue> for NSNumber

fn borrow(&self) -> &NSValue

Immutably borrows from an owned value.

impl Borrow<Object> for NSNumber

fn borrow(&self) -> &Object

Immutably borrows from an owned value.

impl BorrowMut<NSObject> for NSNumber

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

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 BorrowMut<Object> for NSNumber

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

Mutably borrows from an owned value.

impl ClassType for NSNumber

type Super = NSValue

The superclass of this class.

const NAME: &'static str = _

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

fn class() -> &'static Class

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.

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

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

Mutably dereferences the value.

impl Display for NSNumber

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

Formats the value using the given formatter.

impl Hash for NSNumber

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, 

Feeds a slice of this type into the given Hasher.

impl NSCopying for NSNumber

type Ownership = Shared

Available on crate feature foundation only.

Indicates whether the type is mutable or immutable.

type Output = NSNumber

Available on crate feature foundation only.

The output type.

fn copy(&self) -> Id<Self::Output, Self::Ownership>

Available on crate feature foundation only.

impl PartialEq<NSNumber> for NSNumber

Beware: This uses the Objective-C method “isEqualToNumber:”, which has different floating point NaN semantics than Rust!

fn eq(&self, other: &Self) -> 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 PartialOrd<NSNumber> for NSNumber

Beware: This uses the Objective-C method “compare:”, which has different floating point NaN semantics than Rust!

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

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

const ENCODING_REF: Encoding = <NSValue as crate::RefEncode>::ENCODING_REF

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

impl ToOwned for NSNumber

type Owned = Id<NSNumber, Shared>

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 NSNumber

impl RefUnwindSafe for NSNumber

impl Send for NSNumber

impl Sync for NSNumber

impl UnwindSafe for NSNumber