pub struct NSNumberFormatter { /* private fields */ }NSFormatter and NSNumberFormatter only.Expand description
Implementations§
Source§impl NSNumberFormatter
impl NSNumberFormatter
pub fn formattingContext(&self) -> NSFormattingContext
Sourcepub fn setFormattingContext(&self, formatting_context: NSFormattingContext)
pub fn setFormattingContext(&self, formatting_context: NSFormattingContext)
Setter for formattingContext.
Sourcepub unsafe fn getObjectValue_forString_range_error(
&self,
obj: Option<&mut Option<Retained<AnyObject>>>,
string: &NSString,
rangep: *mut NSRange,
) -> Result<(), Retained<NSError>>
Available on crate features NSError and NSRange and NSString only.
pub unsafe fn getObjectValue_forString_range_error( &self, obj: Option<&mut Option<Retained<AnyObject>>>, string: &NSString, rangep: *mut NSRange, ) -> Result<(), Retained<NSError>>
NSError and NSRange and NSString only.§Safety
objshould be of the correct type.rangepmust be a valid pointer or null.
pub fn stringFromNumber(&self, number: &NSNumber) -> Option<Retained<NSString>>
NSString and NSValue only.pub fn numberFromString(&self, string: &NSString) -> Option<Retained<NSNumber>>
NSString and NSValue only.pub fn localizedStringFromNumber_numberStyle( num: &NSNumber, nstyle: NSNumberFormatterStyle, ) -> Retained<NSString>
NSString and NSValue only.pub fn defaultFormatterBehavior() -> NSNumberFormatterBehavior
pub fn setDefaultFormatterBehavior(behavior: NSNumberFormatterBehavior)
pub fn minimumGroupingDigits(&self) -> NSInteger
Sourcepub fn setMinimumGroupingDigits(&self, minimum_grouping_digits: NSInteger)
pub fn setMinimumGroupingDigits(&self, minimum_grouping_digits: NSInteger)
Setter for minimumGroupingDigits.
pub fn numberStyle(&self) -> NSNumberFormatterStyle
Sourcepub fn setNumberStyle(&self, number_style: NSNumberFormatterStyle)
pub fn setNumberStyle(&self, number_style: NSNumberFormatterStyle)
Setter for numberStyle.
pub fn locale(&self) -> Retained<NSLocale>
NSLocale only.pub fn generatesDecimalNumbers(&self) -> bool
Sourcepub fn setGeneratesDecimalNumbers(&self, generates_decimal_numbers: bool)
pub fn setGeneratesDecimalNumbers(&self, generates_decimal_numbers: bool)
Setter for generatesDecimalNumbers.
pub fn formatterBehavior(&self) -> NSNumberFormatterBehavior
Sourcepub fn setFormatterBehavior(
&self,
formatter_behavior: NSNumberFormatterBehavior,
)
pub fn setFormatterBehavior( &self, formatter_behavior: NSNumberFormatterBehavior, )
Setter for formatterBehavior.
pub fn negativeFormat(&self) -> Retained<NSString>
NSString only.Sourcepub fn setNegativeFormat(&self, negative_format: Option<&NSString>)
Available on crate feature NSString only.
pub fn setNegativeFormat(&self, negative_format: Option<&NSString>)
NSString only.Setter for negativeFormat.
This is copied when set.
pub fn textAttributesForNegativeValues( &self, ) -> Option<Retained<NSDictionary<NSString, AnyObject>>>
NSDictionary and NSString only.Sourcepub unsafe fn setTextAttributesForNegativeValues(
&self,
text_attributes_for_negative_values: Option<&NSDictionary<NSString, AnyObject>>,
)
Available on crate features NSDictionary and NSString only.
pub unsafe fn setTextAttributesForNegativeValues( &self, text_attributes_for_negative_values: Option<&NSDictionary<NSString, AnyObject>>, )
NSDictionary and NSString only.Setter for textAttributesForNegativeValues.
This is copied when set.
§Safety
text_attributes_for_negative_values generic should be of the correct type.
pub fn positiveFormat(&self) -> Retained<NSString>
NSString only.Sourcepub fn setPositiveFormat(&self, positive_format: Option<&NSString>)
Available on crate feature NSString only.
pub fn setPositiveFormat(&self, positive_format: Option<&NSString>)
NSString only.Setter for positiveFormat.
This is copied when set.
pub fn textAttributesForPositiveValues( &self, ) -> Option<Retained<NSDictionary<NSString, AnyObject>>>
NSDictionary and NSString only.Sourcepub unsafe fn setTextAttributesForPositiveValues(
&self,
text_attributes_for_positive_values: Option<&NSDictionary<NSString, AnyObject>>,
)
Available on crate features NSDictionary and NSString only.
pub unsafe fn setTextAttributesForPositiveValues( &self, text_attributes_for_positive_values: Option<&NSDictionary<NSString, AnyObject>>, )
NSDictionary and NSString only.Setter for textAttributesForPositiveValues.
This is copied when set.
§Safety
text_attributes_for_positive_values generic should be of the correct type.
pub fn allowsFloats(&self) -> bool
Sourcepub fn setAllowsFloats(&self, allows_floats: bool)
pub fn setAllowsFloats(&self, allows_floats: bool)
Setter for allowsFloats.
pub fn decimalSeparator(&self) -> Retained<NSString>
NSString only.Sourcepub fn setDecimalSeparator(&self, decimal_separator: Option<&NSString>)
Available on crate feature NSString only.
pub fn setDecimalSeparator(&self, decimal_separator: Option<&NSString>)
NSString only.Setter for decimalSeparator.
This is copied when set.
pub fn alwaysShowsDecimalSeparator(&self) -> bool
Sourcepub fn setAlwaysShowsDecimalSeparator(
&self,
always_shows_decimal_separator: bool,
)
pub fn setAlwaysShowsDecimalSeparator( &self, always_shows_decimal_separator: bool, )
Setter for alwaysShowsDecimalSeparator.
pub fn currencyDecimalSeparator(&self) -> Retained<NSString>
NSString only.Sourcepub fn setCurrencyDecimalSeparator(
&self,
currency_decimal_separator: Option<&NSString>,
)
Available on crate feature NSString only.
pub fn setCurrencyDecimalSeparator( &self, currency_decimal_separator: Option<&NSString>, )
NSString only.Setter for currencyDecimalSeparator.
This is copied when set.
pub fn usesGroupingSeparator(&self) -> bool
Sourcepub fn setUsesGroupingSeparator(&self, uses_grouping_separator: bool)
pub fn setUsesGroupingSeparator(&self, uses_grouping_separator: bool)
Setter for usesGroupingSeparator.
pub fn groupingSeparator(&self) -> Retained<NSString>
NSString only.Sourcepub fn setGroupingSeparator(&self, grouping_separator: Option<&NSString>)
Available on crate feature NSString only.
pub fn setGroupingSeparator(&self, grouping_separator: Option<&NSString>)
NSString only.Setter for groupingSeparator.
This is copied when set.
pub fn zeroSymbol(&self) -> Option<Retained<NSString>>
NSString only.Sourcepub fn setZeroSymbol(&self, zero_symbol: Option<&NSString>)
Available on crate feature NSString only.
pub fn setZeroSymbol(&self, zero_symbol: Option<&NSString>)
NSString only.Setter for zeroSymbol.
This is copied when set.
pub fn textAttributesForZero( &self, ) -> Option<Retained<NSDictionary<NSString, AnyObject>>>
NSDictionary and NSString only.Sourcepub unsafe fn setTextAttributesForZero(
&self,
text_attributes_for_zero: Option<&NSDictionary<NSString, AnyObject>>,
)
Available on crate features NSDictionary and NSString only.
pub unsafe fn setTextAttributesForZero( &self, text_attributes_for_zero: Option<&NSDictionary<NSString, AnyObject>>, )
NSDictionary and NSString only.Setter for textAttributesForZero.
This is copied when set.
§Safety
text_attributes_for_zero generic should be of the correct type.
pub fn nilSymbol(&self) -> Retained<NSString>
NSString only.Sourcepub fn setNilSymbol(&self, nil_symbol: &NSString)
Available on crate feature NSString only.
pub fn setNilSymbol(&self, nil_symbol: &NSString)
NSString only.pub fn textAttributesForNil( &self, ) -> Option<Retained<NSDictionary<NSString, AnyObject>>>
NSDictionary and NSString only.Sourcepub unsafe fn setTextAttributesForNil(
&self,
text_attributes_for_nil: Option<&NSDictionary<NSString, AnyObject>>,
)
Available on crate features NSDictionary and NSString only.
pub unsafe fn setTextAttributesForNil( &self, text_attributes_for_nil: Option<&NSDictionary<NSString, AnyObject>>, )
NSDictionary and NSString only.Setter for textAttributesForNil.
This is copied when set.
§Safety
text_attributes_for_nil generic should be of the correct type.
pub fn notANumberSymbol(&self) -> Retained<NSString>
NSString only.Sourcepub fn setNotANumberSymbol(&self, not_a_number_symbol: Option<&NSString>)
Available on crate feature NSString only.
pub fn setNotANumberSymbol(&self, not_a_number_symbol: Option<&NSString>)
NSString only.Setter for notANumberSymbol.
This is copied when set.
pub fn textAttributesForNotANumber( &self, ) -> Option<Retained<NSDictionary<NSString, AnyObject>>>
NSDictionary and NSString only.Sourcepub unsafe fn setTextAttributesForNotANumber(
&self,
text_attributes_for_not_a_number: Option<&NSDictionary<NSString, AnyObject>>,
)
Available on crate features NSDictionary and NSString only.
pub unsafe fn setTextAttributesForNotANumber( &self, text_attributes_for_not_a_number: Option<&NSDictionary<NSString, AnyObject>>, )
NSDictionary and NSString only.Setter for textAttributesForNotANumber.
This is copied when set.
§Safety
text_attributes_for_not_a_number generic should be of the correct type.
pub fn positiveInfinitySymbol(&self) -> Retained<NSString>
NSString only.Sourcepub fn setPositiveInfinitySymbol(&self, positive_infinity_symbol: &NSString)
Available on crate feature NSString only.
pub fn setPositiveInfinitySymbol(&self, positive_infinity_symbol: &NSString)
NSString only.Setter for positiveInfinitySymbol.
This is copied when set.
pub fn textAttributesForPositiveInfinity( &self, ) -> Option<Retained<NSDictionary<NSString, AnyObject>>>
NSDictionary and NSString only.Sourcepub unsafe fn setTextAttributesForPositiveInfinity(
&self,
text_attributes_for_positive_infinity: Option<&NSDictionary<NSString, AnyObject>>,
)
Available on crate features NSDictionary and NSString only.
pub unsafe fn setTextAttributesForPositiveInfinity( &self, text_attributes_for_positive_infinity: Option<&NSDictionary<NSString, AnyObject>>, )
NSDictionary and NSString only.Setter for textAttributesForPositiveInfinity.
This is copied when set.
§Safety
text_attributes_for_positive_infinity generic should be of the correct type.
pub fn negativeInfinitySymbol(&self) -> Retained<NSString>
NSString only.Sourcepub fn setNegativeInfinitySymbol(&self, negative_infinity_symbol: &NSString)
Available on crate feature NSString only.
pub fn setNegativeInfinitySymbol(&self, negative_infinity_symbol: &NSString)
NSString only.Setter for negativeInfinitySymbol.
This is copied when set.
pub fn textAttributesForNegativeInfinity( &self, ) -> Option<Retained<NSDictionary<NSString, AnyObject>>>
NSDictionary and NSString only.Sourcepub unsafe fn setTextAttributesForNegativeInfinity(
&self,
text_attributes_for_negative_infinity: Option<&NSDictionary<NSString, AnyObject>>,
)
Available on crate features NSDictionary and NSString only.
pub unsafe fn setTextAttributesForNegativeInfinity( &self, text_attributes_for_negative_infinity: Option<&NSDictionary<NSString, AnyObject>>, )
NSDictionary and NSString only.Setter for textAttributesForNegativeInfinity.
This is copied when set.
§Safety
text_attributes_for_negative_infinity generic should be of the correct type.
pub fn positivePrefix(&self) -> Retained<NSString>
NSString only.Sourcepub fn setPositivePrefix(&self, positive_prefix: Option<&NSString>)
Available on crate feature NSString only.
pub fn setPositivePrefix(&self, positive_prefix: Option<&NSString>)
NSString only.Setter for positivePrefix.
This is copied when set.
pub fn positiveSuffix(&self) -> Retained<NSString>
NSString only.Sourcepub fn setPositiveSuffix(&self, positive_suffix: Option<&NSString>)
Available on crate feature NSString only.
pub fn setPositiveSuffix(&self, positive_suffix: Option<&NSString>)
NSString only.Setter for positiveSuffix.
This is copied when set.
pub fn negativePrefix(&self) -> Retained<NSString>
NSString only.Sourcepub fn setNegativePrefix(&self, negative_prefix: Option<&NSString>)
Available on crate feature NSString only.
pub fn setNegativePrefix(&self, negative_prefix: Option<&NSString>)
NSString only.Setter for negativePrefix.
This is copied when set.
pub fn negativeSuffix(&self) -> Retained<NSString>
NSString only.Sourcepub fn setNegativeSuffix(&self, negative_suffix: Option<&NSString>)
Available on crate feature NSString only.
pub fn setNegativeSuffix(&self, negative_suffix: Option<&NSString>)
NSString only.Setter for negativeSuffix.
This is copied when set.
pub fn currencyCode(&self) -> Retained<NSString>
NSString only.Sourcepub fn setCurrencyCode(&self, currency_code: Option<&NSString>)
Available on crate feature NSString only.
pub fn setCurrencyCode(&self, currency_code: Option<&NSString>)
NSString only.Setter for currencyCode.
This is copied when set.
pub fn currencySymbol(&self) -> Retained<NSString>
NSString only.Sourcepub fn setCurrencySymbol(&self, currency_symbol: Option<&NSString>)
Available on crate feature NSString only.
pub fn setCurrencySymbol(&self, currency_symbol: Option<&NSString>)
NSString only.Setter for currencySymbol.
This is copied when set.
pub fn internationalCurrencySymbol(&self) -> Retained<NSString>
NSString only.Sourcepub fn setInternationalCurrencySymbol(
&self,
international_currency_symbol: Option<&NSString>,
)
Available on crate feature NSString only.
pub fn setInternationalCurrencySymbol( &self, international_currency_symbol: Option<&NSString>, )
NSString only.Setter for internationalCurrencySymbol.
This is copied when set.
pub fn percentSymbol(&self) -> Retained<NSString>
NSString only.Sourcepub fn setPercentSymbol(&self, percent_symbol: Option<&NSString>)
Available on crate feature NSString only.
pub fn setPercentSymbol(&self, percent_symbol: Option<&NSString>)
NSString only.Setter for percentSymbol.
This is copied when set.
pub fn perMillSymbol(&self) -> Retained<NSString>
NSString only.Sourcepub fn setPerMillSymbol(&self, per_mill_symbol: Option<&NSString>)
Available on crate feature NSString only.
pub fn setPerMillSymbol(&self, per_mill_symbol: Option<&NSString>)
NSString only.Setter for perMillSymbol.
This is copied when set.
pub fn minusSign(&self) -> Retained<NSString>
NSString only.Sourcepub fn setMinusSign(&self, minus_sign: Option<&NSString>)
Available on crate feature NSString only.
pub fn setMinusSign(&self, minus_sign: Option<&NSString>)
NSString only.pub fn plusSign(&self) -> Retained<NSString>
NSString only.Sourcepub fn setPlusSign(&self, plus_sign: Option<&NSString>)
Available on crate feature NSString only.
pub fn setPlusSign(&self, plus_sign: Option<&NSString>)
NSString only.pub fn exponentSymbol(&self) -> Retained<NSString>
NSString only.Sourcepub fn setExponentSymbol(&self, exponent_symbol: Option<&NSString>)
Available on crate feature NSString only.
pub fn setExponentSymbol(&self, exponent_symbol: Option<&NSString>)
NSString only.Setter for exponentSymbol.
This is copied when set.
pub fn groupingSize(&self) -> NSUInteger
Sourcepub fn setGroupingSize(&self, grouping_size: NSUInteger)
pub fn setGroupingSize(&self, grouping_size: NSUInteger)
Setter for groupingSize.
pub fn secondaryGroupingSize(&self) -> NSUInteger
Sourcepub fn setSecondaryGroupingSize(&self, secondary_grouping_size: NSUInteger)
pub fn setSecondaryGroupingSize(&self, secondary_grouping_size: NSUInteger)
Setter for secondaryGroupingSize.
pub fn multiplier(&self) -> Option<Retained<NSNumber>>
NSValue only.Sourcepub fn setMultiplier(&self, multiplier: Option<&NSNumber>)
Available on crate feature NSValue only.
pub fn setMultiplier(&self, multiplier: Option<&NSNumber>)
NSValue only.Setter for multiplier.
This is copied when set.
pub fn formatWidth(&self) -> NSUInteger
Sourcepub fn setFormatWidth(&self, format_width: NSUInteger)
pub fn setFormatWidth(&self, format_width: NSUInteger)
Setter for formatWidth.
pub fn paddingCharacter(&self) -> Retained<NSString>
NSString only.Sourcepub fn setPaddingCharacter(&self, padding_character: Option<&NSString>)
Available on crate feature NSString only.
pub fn setPaddingCharacter(&self, padding_character: Option<&NSString>)
NSString only.Setter for paddingCharacter.
This is copied when set.
pub fn paddingPosition(&self) -> NSNumberFormatterPadPosition
Sourcepub fn setPaddingPosition(&self, padding_position: NSNumberFormatterPadPosition)
pub fn setPaddingPosition(&self, padding_position: NSNumberFormatterPadPosition)
Setter for paddingPosition.
pub fn roundingMode(&self) -> NSNumberFormatterRoundingMode
Sourcepub fn setRoundingMode(&self, rounding_mode: NSNumberFormatterRoundingMode)
pub fn setRoundingMode(&self, rounding_mode: NSNumberFormatterRoundingMode)
Setter for roundingMode.
pub fn roundingIncrement(&self) -> Retained<NSNumber>
NSValue only.Sourcepub fn setRoundingIncrement(&self, rounding_increment: Option<&NSNumber>)
Available on crate feature NSValue only.
pub fn setRoundingIncrement(&self, rounding_increment: Option<&NSNumber>)
NSValue only.Setter for roundingIncrement.
This is copied when set.
pub fn minimumIntegerDigits(&self) -> NSUInteger
Sourcepub fn setMinimumIntegerDigits(&self, minimum_integer_digits: NSUInteger)
pub fn setMinimumIntegerDigits(&self, minimum_integer_digits: NSUInteger)
Setter for minimumIntegerDigits.
pub fn maximumIntegerDigits(&self) -> NSUInteger
Sourcepub fn setMaximumIntegerDigits(&self, maximum_integer_digits: NSUInteger)
pub fn setMaximumIntegerDigits(&self, maximum_integer_digits: NSUInteger)
Setter for maximumIntegerDigits.
pub fn minimumFractionDigits(&self) -> NSUInteger
Sourcepub fn setMinimumFractionDigits(&self, minimum_fraction_digits: NSUInteger)
pub fn setMinimumFractionDigits(&self, minimum_fraction_digits: NSUInteger)
Setter for minimumFractionDigits.
pub fn maximumFractionDigits(&self) -> NSUInteger
Sourcepub fn setMaximumFractionDigits(&self, maximum_fraction_digits: NSUInteger)
pub fn setMaximumFractionDigits(&self, maximum_fraction_digits: NSUInteger)
Setter for maximumFractionDigits.
pub fn minimum(&self) -> Option<Retained<NSNumber>>
NSValue only.Sourcepub fn setMinimum(&self, minimum: Option<&NSNumber>)
Available on crate feature NSValue only.
pub fn setMinimum(&self, minimum: Option<&NSNumber>)
NSValue only.pub fn maximum(&self) -> Option<Retained<NSNumber>>
NSValue only.Sourcepub fn setMaximum(&self, maximum: Option<&NSNumber>)
Available on crate feature NSValue only.
pub fn setMaximum(&self, maximum: Option<&NSNumber>)
NSValue only.pub fn currencyGroupingSeparator(&self) -> Retained<NSString>
NSString only.Sourcepub fn setCurrencyGroupingSeparator(
&self,
currency_grouping_separator: Option<&NSString>,
)
Available on crate feature NSString only.
pub fn setCurrencyGroupingSeparator( &self, currency_grouping_separator: Option<&NSString>, )
NSString only.Setter for currencyGroupingSeparator.
This is copied when set.
pub fn isLenient(&self) -> bool
Sourcepub fn setLenient(&self, lenient: bool)
pub fn setLenient(&self, lenient: bool)
Setter for isLenient.
pub fn usesSignificantDigits(&self) -> bool
Sourcepub fn setUsesSignificantDigits(&self, uses_significant_digits: bool)
pub fn setUsesSignificantDigits(&self, uses_significant_digits: bool)
Setter for usesSignificantDigits.
pub fn minimumSignificantDigits(&self) -> NSUInteger
Sourcepub fn setMinimumSignificantDigits(
&self,
minimum_significant_digits: NSUInteger,
)
pub fn setMinimumSignificantDigits( &self, minimum_significant_digits: NSUInteger, )
Setter for minimumSignificantDigits.
pub fn maximumSignificantDigits(&self) -> NSUInteger
Sourcepub fn setMaximumSignificantDigits(
&self,
maximum_significant_digits: NSUInteger,
)
pub fn setMaximumSignificantDigits( &self, maximum_significant_digits: NSUInteger, )
Setter for maximumSignificantDigits.
pub fn isPartialStringValidationEnabled(&self) -> bool
Sourcepub fn setPartialStringValidationEnabled(
&self,
partial_string_validation_enabled: bool,
)
pub fn setPartialStringValidationEnabled( &self, partial_string_validation_enabled: bool, )
Setter for isPartialStringValidationEnabled.
Source§impl NSNumberFormatter
Methods declared on superclass NSObject.
impl NSNumberFormatter
Methods declared on superclass NSObject.
Source§impl NSNumberFormatter
NSNumberFormatterCompatibility.
impl NSNumberFormatter
NSNumberFormatterCompatibility.
pub fn hasThousandSeparators(&self) -> bool
Sourcepub fn setHasThousandSeparators(&self, has_thousand_separators: bool)
pub fn setHasThousandSeparators(&self, has_thousand_separators: bool)
Setter for hasThousandSeparators.
pub fn thousandSeparator(&self) -> Retained<NSString>
NSString only.Sourcepub fn setThousandSeparator(&self, thousand_separator: Option<&NSString>)
Available on crate feature NSString only.
pub fn setThousandSeparator(&self, thousand_separator: Option<&NSString>)
NSString only.Setter for thousandSeparator.
This is copied when set.
pub fn localizesFormat(&self) -> bool
Sourcepub fn setLocalizesFormat(&self, localizes_format: bool)
pub fn setLocalizesFormat(&self, localizes_format: bool)
Setter for localizesFormat.
pub fn format(&self) -> Retained<NSString>
NSString only.pub fn attributedStringForZero(&self) -> Retained<NSAttributedString>
NSAttributedString only.Sourcepub fn setAttributedStringForZero(
&self,
attributed_string_for_zero: &NSAttributedString,
)
Available on crate feature NSAttributedString only.
pub fn setAttributedStringForZero( &self, attributed_string_for_zero: &NSAttributedString, )
NSAttributedString only.Setter for attributedStringForZero.
This is copied when set.
pub fn attributedStringForNil(&self) -> Retained<NSAttributedString>
NSAttributedString only.Sourcepub fn setAttributedStringForNil(
&self,
attributed_string_for_nil: &NSAttributedString,
)
Available on crate feature NSAttributedString only.
pub fn setAttributedStringForNil( &self, attributed_string_for_nil: &NSAttributedString, )
NSAttributedString only.Setter for attributedStringForNil.
This is copied when set.
pub fn attributedStringForNotANumber(&self) -> Retained<NSAttributedString>
NSAttributedString only.Sourcepub fn setAttributedStringForNotANumber(
&self,
attributed_string_for_not_a_number: &NSAttributedString,
)
Available on crate feature NSAttributedString only.
pub fn setAttributedStringForNotANumber( &self, attributed_string_for_not_a_number: &NSAttributedString, )
NSAttributedString only.Setter for attributedStringForNotANumber.
This is copied when set.
pub fn roundingBehavior(&self) -> Retained<NSDecimalNumberHandler>
NSDecimalNumber only.Sourcepub fn setRoundingBehavior(&self, rounding_behavior: &NSDecimalNumberHandler)
Available on crate feature NSDecimalNumber only.
pub fn setRoundingBehavior(&self, rounding_behavior: &NSDecimalNumberHandler)
NSDecimalNumber only.Setter for roundingBehavior.
This is copied when set.
Methods from Deref<Target = NSFormatter>§
Sourcepub unsafe fn stringForObjectValue(
&self,
obj: Option<&AnyObject>,
) -> Option<Retained<NSString>>
Available on crate feature NSString only.
pub unsafe fn stringForObjectValue( &self, obj: Option<&AnyObject>, ) -> Option<Retained<NSString>>
NSString only.§Safety
obj should be of the correct type.
Sourcepub unsafe fn attributedStringForObjectValue_withDefaultAttributes(
&self,
obj: &AnyObject,
attrs: Option<&NSDictionary<NSAttributedStringKey, AnyObject>>,
) -> Option<Retained<NSAttributedString>>
Available on crate features NSAttributedString and NSDictionary and NSString only.
pub unsafe fn attributedStringForObjectValue_withDefaultAttributes( &self, obj: &AnyObject, attrs: Option<&NSDictionary<NSAttributedStringKey, AnyObject>>, ) -> Option<Retained<NSAttributedString>>
NSAttributedString and NSDictionary and NSString only.§Safety
objshould be of the correct type.attrsgeneric should be of the correct type.
Sourcepub unsafe fn editingStringForObjectValue(
&self,
obj: &AnyObject,
) -> Option<Retained<NSString>>
Available on crate feature NSString only.
pub unsafe fn editingStringForObjectValue( &self, obj: &AnyObject, ) -> Option<Retained<NSString>>
NSString only.§Safety
obj should be of the correct type.
Sourcepub unsafe fn getObjectValue_forString_errorDescription(
&self,
obj: Option<&mut Option<Retained<AnyObject>>>,
string: &NSString,
error: Option<&mut Option<Retained<NSString>>>,
) -> bool
Available on crate feature NSString only.
pub unsafe fn getObjectValue_forString_errorDescription( &self, obj: Option<&mut Option<Retained<AnyObject>>>, string: &NSString, error: Option<&mut Option<Retained<NSString>>>, ) -> bool
NSString only.§Safety
obj should be of the correct type.
pub fn isPartialStringValid_newEditingString_errorDescription( &self, partial_string: &NSString, new_string: Option<&mut Option<Retained<NSString>>>, error: Option<&mut Option<Retained<NSString>>>, ) -> bool
NSString only.Sourcepub unsafe fn isPartialStringValid_proposedSelectedRange_originalString_originalSelectedRange_errorDescription(
&self,
partial_string_ptr: &mut Retained<NSString>,
proposed_sel_range_ptr: NSRangePointer,
orig_string: &NSString,
orig_sel_range: NSRange,
error: Option<&mut Option<Retained<NSString>>>,
) -> bool
Available on crate features NSRange and NSString only.
pub unsafe fn isPartialStringValid_proposedSelectedRange_originalString_originalSelectedRange_errorDescription( &self, partial_string_ptr: &mut Retained<NSString>, proposed_sel_range_ptr: NSRangePointer, orig_string: &NSString, orig_sel_range: NSRange, error: Option<&mut Option<Retained<NSString>>>, ) -> bool
NSRange and NSString only.§Safety
proposed_sel_range_ptr must be a valid pointer or null.
Methods from Deref<Target = NSObject>§
Sourcepub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
Handle messages the object doesn’t recognize.
See Apple’s documentation for details.
Methods from Deref<Target = AnyObject>§
Sourcepub fn class(&self) -> &'static AnyClass
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());Sourcepub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
👎Deprecated: this is difficult to use correctly, use Ivar::load instead.
pub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
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.
Sourcepub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
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§
Source§impl AsRef<AnyObject> for NSNumberFormatter
impl AsRef<AnyObject> for NSNumberFormatter
Source§impl AsRef<NSFormatter> for NSNumberFormatter
impl AsRef<NSFormatter> for NSNumberFormatter
Source§fn as_ref(&self) -> &NSFormatter
fn as_ref(&self) -> &NSFormatter
Source§impl AsRef<NSNumberFormatter> for NSNumberFormatter
impl AsRef<NSNumberFormatter> for NSNumberFormatter
Source§impl AsRef<NSObject> for NSNumberFormatter
impl AsRef<NSObject> for NSNumberFormatter
Source§impl Borrow<AnyObject> for NSNumberFormatter
impl Borrow<AnyObject> for NSNumberFormatter
Source§impl Borrow<NSFormatter> for NSNumberFormatter
impl Borrow<NSFormatter> for NSNumberFormatter
Source§fn borrow(&self) -> &NSFormatter
fn borrow(&self) -> &NSFormatter
Source§impl Borrow<NSObject> for NSNumberFormatter
impl Borrow<NSObject> for NSNumberFormatter
Source§impl ClassType for NSNumberFormatter
impl ClassType for NSNumberFormatter
Source§const NAME: &'static str = "NSNumberFormatter"
const NAME: &'static str = "NSNumberFormatter"
Source§type Super = NSFormatter
type Super = NSFormatter
Source§type ThreadKind = <<NSNumberFormatter as ClassType>::Super as ClassType>::ThreadKind
type ThreadKind = <<NSNumberFormatter as ClassType>::Super as ClassType>::ThreadKind
Source§impl CopyingHelper for NSNumberFormatter
Available on crate feature NSObject only.
impl CopyingHelper for NSNumberFormatter
NSObject only.Source§type Result = NSNumberFormatter
type Result = NSNumberFormatter
Self if the type has no
immutable counterpart. Read moreSource§impl Debug for NSNumberFormatter
impl Debug for NSNumberFormatter
Source§impl DefaultRetained for NSNumberFormatter
impl DefaultRetained for NSNumberFormatter
Source§impl Deref for NSNumberFormatter
impl Deref for NSNumberFormatter
Source§impl Hash for NSNumberFormatter
impl Hash for NSNumberFormatter
Source§impl Message for NSNumberFormatter
impl Message for NSNumberFormatter
Source§impl NSCoding for NSNumberFormatter
impl NSCoding for NSNumberFormatter
Source§unsafe fn encodeWithCoder(&self, coder: &NSCoder)
unsafe fn encodeWithCoder(&self, coder: &NSCoder)
NSObject and NSCoder only.Source§impl NSCopying for NSNumberFormatter
impl NSCopying for NSNumberFormatter
Source§impl NSObjectProtocol for NSNumberFormatter
impl NSObjectProtocol for NSNumberFormatter
Source§fn isEqual(&self, other: Option<&AnyObject>) -> bool
fn isEqual(&self, other: Option<&AnyObject>) -> bool
Source§fn hash(&self) -> usize
fn hash(&self) -> usize
Source§fn isKindOfClass(&self, cls: &AnyClass) -> bool
fn isKindOfClass(&self, cls: &AnyClass) -> bool
Source§fn is_kind_of<T>(&self) -> bool
fn is_kind_of<T>(&self) -> bool
isKindOfClass directly, or cast your objects with AnyObject::downcast_ref