Struct NSDecimalNumber 

pub struct NSDecimalNumber { /* private fields */ }

Available on crate features NSDecimalNumber and NSValue only.

************* NSDecimalNumber: the class **********

See also Apple’s documentation

Implementations

impl NSDecimalNumber

pub fn initWithMantissa_exponent_isNegative( this: Allocated<Self>, mantissa: c_ulonglong, exponent: c_short, flag: bool, ) -> Retained<Self>

pub fn initWithDecimal(this: Allocated<Self>, dcm: NSDecimal) -> Retained<Self>

Available on crate feature NSDecimal only.

pub fn initWithString( this: Allocated<Self>, number_value: Option<&NSString>, ) -> Retained<Self>

Available on crate feature NSString only.

pub unsafe fn initWithString_locale( this: Allocated<Self>, number_value: Option<&NSString>, locale: Option<&AnyObject>, ) -> Retained<Self>

Available on crate feature NSString only.

Safety

locale should be of the correct type.

pub unsafe fn descriptionWithLocale( &self, locale: Option<&AnyObject>, ) -> Retained<NSString>

Available on crate feature NSString only.

Safety

locale should be of the correct type.

pub fn decimalValue(&self) -> NSDecimal

Available on crate feature NSDecimal only.

pub fn decimalNumberWithMantissa_exponent_isNegative( mantissa: c_ulonglong, exponent: c_short, flag: bool, ) -> Retained<NSDecimalNumber>

pub fn decimalNumberWithDecimal(dcm: NSDecimal) -> Retained<NSDecimalNumber>

Available on crate feature NSDecimal only.

pub fn decimalNumberWithString( number_value: Option<&NSString>, ) -> Retained<NSDecimalNumber>

Available on crate feature NSString only.

pub unsafe fn decimalNumberWithString_locale( number_value: Option<&NSString>, locale: Option<&AnyObject>, ) -> Retained<NSDecimalNumber>

Available on crate feature NSString only.

Safety

locale should be of the correct type.

pub fn zero() -> Retained<NSDecimalNumber>

pub fn one() -> Retained<NSDecimalNumber>

pub fn minimumDecimalNumber() -> Retained<NSDecimalNumber>

pub fn maximumDecimalNumber() -> Retained<NSDecimalNumber>

pub fn notANumber() -> Retained<NSDecimalNumber>

pub fn decimalNumberByAdding( &self, decimal_number: &NSDecimalNumber, ) -> Retained<NSDecimalNumber>

pub fn decimalNumberByAdding_withBehavior( &self, decimal_number: &NSDecimalNumber, behavior: Option<&ProtocolObject<dyn NSDecimalNumberBehaviors>>, ) -> Retained<NSDecimalNumber>

pub fn decimalNumberBySubtracting( &self, decimal_number: &NSDecimalNumber, ) -> Retained<NSDecimalNumber>

pub fn decimalNumberBySubtracting_withBehavior( &self, decimal_number: &NSDecimalNumber, behavior: Option<&ProtocolObject<dyn NSDecimalNumberBehaviors>>, ) -> Retained<NSDecimalNumber>

pub fn decimalNumberByMultiplyingBy( &self, decimal_number: &NSDecimalNumber, ) -> Retained<NSDecimalNumber>

pub fn decimalNumberByMultiplyingBy_withBehavior( &self, decimal_number: &NSDecimalNumber, behavior: Option<&ProtocolObject<dyn NSDecimalNumberBehaviors>>, ) -> Retained<NSDecimalNumber>

pub fn decimalNumberByDividingBy( &self, decimal_number: &NSDecimalNumber, ) -> Retained<NSDecimalNumber>

pub fn decimalNumberByDividingBy_withBehavior( &self, decimal_number: &NSDecimalNumber, behavior: Option<&ProtocolObject<dyn NSDecimalNumberBehaviors>>, ) -> Retained<NSDecimalNumber>

pub fn decimalNumberByRaisingToPower( &self, power: NSUInteger, ) -> Retained<NSDecimalNumber>

pub fn decimalNumberByRaisingToPower_withBehavior( &self, power: NSUInteger, behavior: Option<&ProtocolObject<dyn NSDecimalNumberBehaviors>>, ) -> Retained<NSDecimalNumber>

pub fn decimalNumberByMultiplyingByPowerOf10( &self, power: c_short, ) -> Retained<NSDecimalNumber>

pub fn decimalNumberByMultiplyingByPowerOf10_withBehavior( &self, power: c_short, behavior: Option<&ProtocolObject<dyn NSDecimalNumberBehaviors>>, ) -> Retained<NSDecimalNumber>

pub fn decimalNumberByRoundingAccordingToBehavior( &self, behavior: Option<&ProtocolObject<dyn NSDecimalNumberBehaviors>>, ) -> Retained<NSDecimalNumber>

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

Available on crate feature NSObjCRuntime only.

pub fn defaultBehavior() -> Retained<ProtocolObject<dyn NSDecimalNumberBehaviors>>

pub fn setDefaultBehavior( default_behavior: &ProtocolObject<dyn NSDecimalNumberBehaviors>, )

Setter for defaultBehavior.

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

pub fn doubleValue(&self) -> c_double

impl NSDecimalNumber

Methods declared on superclass NSNumber.

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

Available on crate feature NSCoder only.

Safety

coder possibly has further requirements.

impl NSDecimalNumber

Methods declared on superclass NSValue.

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

Safety

• value must be a valid pointer.
• type must be a valid pointer.

impl NSDecimalNumber

Methods declared on superclass NSObject.

pub fn init(this: Allocated<Self>) -> Retained<Self>

pub fn new() -> Retained<Self>

Methods from Deref<Target = NSNumber>

pub fn decimalValue(&self) -> NSDecimal

Available on crate feature NSDecimal only.

pub fn charValue(&self) -> c_char

pub fn unsignedCharValue(&self) -> c_uchar

pub fn shortValue(&self) -> c_short

pub fn unsignedShortValue(&self) -> c_ushort

pub fn intValue(&self) -> c_int

pub fn unsignedIntValue(&self) -> c_uint

pub fn longValue(&self) -> c_long

pub fn unsignedLongValue(&self) -> c_ulong

pub fn longLongValue(&self) -> c_longlong

pub fn unsignedLongLongValue(&self) -> c_ulonglong

pub fn floatValue(&self) -> c_float

pub fn doubleValue(&self) -> c_double

pub fn boolValue(&self) -> bool

pub fn integerValue(&self) -> NSInteger

pub fn unsignedIntegerValue(&self) -> NSUInteger

pub fn stringValue(&self) -> Retained<NSString>

Available on crate feature NSString only.

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

Available on crate feature NSObjCRuntime only.

pub fn isEqualToNumber(&self, number: &NSNumber) -> bool

pub unsafe fn descriptionWithLocale( &self, locale: Option<&AnyObject>, ) -> Retained<NSString>

Available on crate feature NSString only.

Safety

locale should be of the correct type.

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

Available on crate features objc2-core-foundation and NSGeometry only.

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_foundation::NSNumber;
use objc2::encode::Encoding;
use objc2::rc::Retained;

// 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) -> Retained<NSNumber> {
        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 pointValue(&self) -> NSPoint

Available on crate features NSGeometry and objc2-core-foundation only.

pub unsafe fn sizeValue(&self) -> NSSize

Available on crate features NSGeometry and objc2-core-foundation only.

pub unsafe fn rectValue(&self) -> NSRect

Available on crate features NSGeometry and objc2-core-foundation only.

pub unsafe fn edgeInsetsValue(&self) -> NSEdgeInsets

Available on crate features NSGeometry and objc2-core-foundation only.

pub unsafe fn rangeValue(&self) -> NSRange

Available on crate feature NSRange only.

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

Safety

value must be a valid pointer.

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

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

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

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

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

👎Deprecated

Safety

value must be a valid pointer.

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

Retrieve the data contained in the NSValue.

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

Available on crate feature NSRange only.

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

Available on crate features NSGeometry and objc2-core-foundation only.

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

Available on crate features NSGeometry and objc2-core-foundation only.

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

Available on crate features NSGeometry and objc2-core-foundation only.

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

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

Methods from Deref<Target = NSObject>

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

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.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

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 fn downcast_ref<T>(&self) -> Option<&T>

where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AnyObject> for NSDecimalNumber

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSDecimalNumber> for NSDecimalNumber

fn as_ref(&self) -> &Self

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

impl AsRef<NSNumber> for NSDecimalNumber

fn as_ref(&self) -> &NSNumber

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

impl AsRef<NSObject> for NSDecimalNumber

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 Borrow<AnyObject> for NSDecimalNumber

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSNumber> for NSDecimalNumber

fn borrow(&self) -> &NSNumber

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSDecimalNumber

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 ClassType for NSDecimalNumber

const NAME: &'static str = "NSDecimalNumber"

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

type Super = NSNumber

The superclass of this class.

type ThreadKind = <<NSDecimalNumber as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

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.

impl CopyingHelper for NSDecimalNumber

Available on crate feature NSObject only.

type Result = NSDecimalNumber

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for NSDecimalNumber

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

Formats the value using the given formatter.

impl DefaultRetained for NSDecimalNumber

fn default_retained() -> Retained<Self>

The default Retained for a type.

impl Deref for NSDecimalNumber

type Target = NSNumber

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSDecimalNumber

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

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for NSDecimalNumber

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

where Self: Sized + Message,

Available on crate features NSObject and NSCoder only.

Safety

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

where Self: Sized + Message,

Available on crate features NSObject and NSCoder only.

Safety

impl NSCopying for NSDecimalNumber

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Available on crate feature NSObject only.

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

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

where Self: Sized + Message + CopyingHelper,

Available on crate feature NSObject only.

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

impl NSObjectProtocol for NSDecimalNumber

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

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

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

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<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 NSDecimalNumber

fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

Available on crate feature NSObject only.

impl PartialEq for NSDecimalNumber

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 NSDecimalNumber

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

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

impl DowncastTarget for NSDecimalNumber

impl Eq for NSDecimalNumber

impl Send for NSDecimalNumber

impl Sync for NSDecimalNumber