Struct NSLocale

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

Available on crate feature NSLocale only.

Apple’s documentation

Implementations

impl NSLocale

pub unsafe fn objectForKey( &self, key: &NSLocaleKey, ) -> Option<Retained<AnyObject>>

Available on crate feature NSString only.

pub unsafe fn displayNameForKey_value( &self, key: &NSLocaleKey, value: &AnyObject, ) -> Option<Retained<NSString>>

Available on crate feature NSString only.

pub unsafe fn initWithLocaleIdentifier( this: Allocated<Self>, string: &NSString, ) -> Retained<Self>

Available on crate feature NSString only.

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

Available on crate feature NSCoder only.

impl NSLocale

NSExtendedLocale.

pub unsafe fn localeIdentifier(&self) -> Retained<NSString>

Available on crate feature NSString only.

pub unsafe fn localizedStringForLocaleIdentifier( &self, locale_identifier: &NSString, ) -> Retained<NSString>

Available on crate feature NSString only.

pub unsafe fn languageCode(&self) -> Retained<NSString>

Available on crate feature NSString only.

pub unsafe fn localizedStringForLanguageCode( &self, language_code: &NSString, ) -> Option<Retained<NSString>>

Available on crate feature NSString only.

pub unsafe fn languageIdentifier(&self) -> Retained<NSString>

Available on crate feature NSString only.

Returns the identifier for the language part of the locale. For example, returns “en-US” for “en_US@rg=gbzzzz” locale.

pub unsafe fn countryCode(&self) -> Option<Retained<NSString>>

👎Deprecated

Available on crate feature NSString only.

pub unsafe fn localizedStringForCountryCode( &self, country_code: &NSString, ) -> Option<Retained<NSString>>

Available on crate feature NSString only.

pub unsafe fn regionCode(&self) -> Option<Retained<NSString>>

Available on crate feature NSString only.

Returns the region code of the locale. If the rg subtag is present, the value of the subtag will be used. For example, returns “GB” for “en_US@rg=gbzzzz” locale. If the localeIdentifier doesn’t contain a region, returns nil.

pub unsafe fn scriptCode(&self) -> Option<Retained<NSString>>

Available on crate feature NSString only.

pub unsafe fn localizedStringForScriptCode( &self, script_code: &NSString, ) -> Option<Retained<NSString>>

Available on crate feature NSString only.

pub unsafe fn variantCode(&self) -> Option<Retained<NSString>>

Available on crate feature NSString only.

pub unsafe fn localizedStringForVariantCode( &self, variant_code: &NSString, ) -> Option<Retained<NSString>>

Available on crate feature NSString only.

pub unsafe fn exemplarCharacterSet(&self) -> Retained<NSCharacterSet>

Available on crate feature NSCharacterSet only.

pub unsafe fn calendarIdentifier(&self) -> Retained<NSString>

Available on crate feature NSString only.

pub unsafe fn localizedStringForCalendarIdentifier( &self, calendar_identifier: &NSString, ) -> Option<Retained<NSString>>

Available on crate feature NSString only.

pub unsafe fn collationIdentifier(&self) -> Option<Retained<NSString>>

Available on crate feature NSString only.

pub unsafe fn localizedStringForCollationIdentifier( &self, collation_identifier: &NSString, ) -> Option<Retained<NSString>>

Available on crate feature NSString only.

pub unsafe fn usesMetricSystem(&self) -> bool

pub unsafe fn decimalSeparator(&self) -> Retained<NSString>

Available on crate feature NSString only.

pub unsafe fn groupingSeparator(&self) -> Retained<NSString>

Available on crate feature NSString only.

pub unsafe fn currencySymbol(&self) -> Retained<NSString>

Available on crate feature NSString only.

pub unsafe fn currencyCode(&self) -> Option<Retained<NSString>>

Available on crate feature NSString only.

pub unsafe fn localizedStringForCurrencyCode( &self, currency_code: &NSString, ) -> Option<Retained<NSString>>

Available on crate feature NSString only.

pub unsafe fn collatorIdentifier(&self) -> Retained<NSString>

Available on crate feature NSString only.

pub unsafe fn localizedStringForCollatorIdentifier( &self, collator_identifier: &NSString, ) -> Option<Retained<NSString>>

Available on crate feature NSString only.

pub unsafe fn quotationBeginDelimiter(&self) -> Retained<NSString>

Available on crate feature NSString only.

pub unsafe fn quotationEndDelimiter(&self) -> Retained<NSString>

Available on crate feature NSString only.

pub unsafe fn alternateQuotationBeginDelimiter(&self) -> Retained<NSString>

Available on crate feature NSString only.

pub unsafe fn alternateQuotationEndDelimiter(&self) -> Retained<NSString>

Available on crate feature NSString only.

impl NSLocale

NSLocaleCreation.

pub unsafe fn autoupdatingCurrentLocale() -> Retained<NSLocale>

pub unsafe fn currentLocale() -> Retained<NSLocale>

pub unsafe fn systemLocale() -> Retained<NSLocale>

pub unsafe fn localeWithLocaleIdentifier(ident: &NSString) -> Retained<Self>

Available on crate feature NSString only.

impl NSLocale

NSLocaleGeneralInfo.

pub unsafe fn availableLocaleIdentifiers() -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

pub unsafe fn ISOLanguageCodes() -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

pub unsafe fn ISOCountryCodes() -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

pub unsafe fn ISOCurrencyCodes() -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

pub unsafe fn commonISOCurrencyCodes() -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

pub unsafe fn preferredLanguages() -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

pub unsafe fn componentsFromLocaleIdentifier( string: &NSString, ) -> Retained<NSDictionary<NSString, NSString>>

Available on crate features NSDictionary and NSString only.

pub unsafe fn localeIdentifierFromComponents( dict: &NSDictionary<NSString, NSString>, ) -> Retained<NSString>

Available on crate features NSDictionary and NSString only.

pub unsafe fn canonicalLocaleIdentifierFromString( string: &NSString, ) -> Retained<NSString>

Available on crate feature NSString only.

pub unsafe fn canonicalLanguageIdentifierFromString( string: &NSString, ) -> Retained<NSString>

Available on crate feature NSString only.

pub unsafe fn localeIdentifierFromWindowsLocaleCode( lcid: u32, ) -> Option<Retained<NSString>>

Available on crate feature NSString only.

pub unsafe fn windowsLocaleCodeFromLocaleIdentifier( locale_identifier: &NSString, ) -> u32

Available on crate feature NSString only.

pub unsafe fn characterDirectionForLanguage( iso_lang_code: &NSString, ) -> NSLocaleLanguageDirection

Available on crate feature NSString only.

pub unsafe fn lineDirectionForLanguage( iso_lang_code: &NSString, ) -> NSLocaleLanguageDirection

Available on crate feature NSString only.

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 NSLocale

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSLocale> for NSLocale

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for NSLocale

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for NSLocale

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSLocale

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSLocale

const NAME: &'static str = "NSLocale"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<NSLocale 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 NSLocale

Available on crate feature NSObject only.

type Result = NSLocale

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

impl Debug for NSLocale

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

Formats the value using the given formatter.

impl Deref for NSLocale

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSLocale

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 NSLocale

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for NSLocale

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

where Self: Sized + Message,

Available on crate features NSObject and NSCoder only.

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

where Self: Sized + Message,

Available on crate features NSObject and NSCoder only.

impl NSCopying for NSLocale

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 NSLocale

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 NSLocale

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

Available on crate feature NSObject only.

impl PartialEq for NSLocale

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 NSLocale

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

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

impl DowncastTarget for NSLocale

impl Eq for NSLocale

impl Send for NSLocale

impl Sync for NSLocale