Struct NSLocale

#[repr(C)]
pub struct NSLocale {
    pub ptr: Id<Object>,
}

The NSLocale class provides information about the user’s locale and formatting preferences.

Fields

ptr: Id<Object>

The raw pointer to the Objective-C object.

Implementations

impl NSLocale

pub fn locale_with_locale_identifier(string: &NSString) -> Self

Returns a locale initialized using the given locale identifier.

pub fn init_with_locale_identifier( &mut self, locale_identifier: &NSString, ) -> Self

where Self: Sized + FromId,

Initializes a locale using a given locale identifier.

pub fn init_with_coder(&mut self, coder: &NSCoder) -> Self

where Self: Sized + FromId,

Returns a locale initialized from data in the given unarchiver.

pub fn autoupdating_current_locale() -> NSLocale

A locale which tracks the user’s current preferences.

pub fn current_locale() -> NSLocale

A locale representing the user’s region settings at the time the property is read.

pub fn system_locale() -> NSLocale

A locale representing the generic root values with little localization.

pub fn available_locale_identifiers() -> NSArray<NSString>

The list of locale identifiers available on the system.

pub fn iso_country_codes() -> NSArray<NSString>

The list of known country or region codes.

pub fn iso_language_codes() -> NSArray<NSString>

The list of known language codes.

pub fn iso_currency_codes() -> NSArray<NSString>

The list of known currency codes.

pub fn common_isocurrency_codes() -> NSArray<NSString>

A list of commonly encountered currency codes.

pub fn canonical_locale_identifier_from_string(string: &NSString) -> NSString

Returns the canonical identifier for a given locale identification string.

pub fn components_from_locale_identifier( string: &NSString, ) -> NSDictionary<NSString, NSString>

Returns a dictionary that is the result of parsing a locale ID.

pub fn locale_identifier_from_components( dict: &NSDictionary<NSString, NSString>, ) -> NSString

Returns a locale identifier from the components specified in a given dictionary.

pub fn canonical_language_identifier_from_string(string: &NSString) -> NSString

Returns a canonical language identifier by mapping an arbitrary locale identification string to the canonical identifier.

pub fn locale_identifier_from_windows_locale_code(lcid: u32) -> Option<NSString>

Returns a locale identifier from a Windows locale code.

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

Returns a Window locale code from the locale identifier.

pub fn locale_identifier(&self) -> NSString

The identifier for the locale.

pub fn country_code(&self) -> Option<NSString>

The country or region code for the locale.

pub fn language_code(&self) -> NSString

The language code for the locale.

pub fn script_code(&self) -> Option<NSString>

The script code for the locale.

pub fn variant_code(&self) -> Option<NSString>

The variant code for the locale.

pub fn exemplar_character_set(&self) -> NSCharacterSet

The exemplar character set for the locale.

pub fn collation_identifier(&self) -> Option<NSString>

The collation identifier for the locale.

pub fn collator_identifier(&self) -> NSString

The collator identifier for the locale.

pub fn uses_metric_system(&self) -> bool

A Boolean value that indicates whether the locale uses the metric system.

pub fn decimal_separator(&self) -> NSString

The decimal separator for the locale.

pub fn grouping_separator(&self) -> NSString

The grouping separator for the locale.

pub fn currency_code(&self) -> Option<NSString>

The currency code for the locale.

pub fn currency_symbol(&self) -> NSString

The currency symbol for the locale.

pub fn calendar_identifier(&self) -> NSString

The calendar identifier for the locale.

pub fn quotation_begin_delimiter(&self) -> NSString

The begin quotation symbol for the locale.

pub fn quotation_end_delimiter(&self) -> NSString

The end quotation symbol for the locale.

pub fn alternate_quotation_begin_delimiter(&self) -> NSString

The alternate begin quotation symbol for the locale.

pub fn alternate_quotation_end_delimiter(&self) -> NSString

The alternate end quotation symbol for the locale.

pub fn localized_string_for_locale_identifier( &self, locale_identifier: &NSString, ) -> NSString

Returns the localized string for the specified locale identifier.

pub fn localized_string_for_country_code( &self, country_code: &NSString, ) -> Option<NSString>

Returns the localized string for a country or region code.

pub fn localized_string_for_language_code( &self, language_code: &NSString, ) -> Option<NSString>

Returns the localized string for the specified language code.

pub fn localized_string_for_script_code( &self, script_code: &NSString, ) -> Option<NSString>

Returns the localized string for the specified script code.

pub fn localized_string_for_variant_code( &self, variant_code: &NSString, ) -> Option<NSString>

Returns the localized string for the specified variant code.

pub fn localized_string_for_collation_identifier( &self, collation_identifier: &NSString, ) -> Option<NSString>

Returns the localized string for the specified collation identifier.

pub fn localized_string_for_collator_identifier( &self, collator_identifier: &NSString, ) -> Option<NSString>

Returns the localized string for the specified collator identifier.

pub fn localized_string_for_currency_code( &self, currency_code: &NSString, ) -> Option<NSString>

Returns the localized string for the specified currency code.

pub fn localized_string_for_calendar_identifier( &self, calendar_identifier: &NSString, ) -> Option<NSString>

Returns the localized string for the specified language code.

pub fn object_for_key(&self, key: NSLocaleKey) -> Option<id>

Returns the value of the component corresponding to the specified key.

pub fn display_name_for_key_value( &self, key: NSLocaleKey, value: &NSString, ) -> Option<NSString>

Returns the display name for the given locale component value.

pub fn preferred_languages() -> NSArray<NSString>

An ordered list of the user’s preferred languages.

pub fn character_direction_for_language( iso_language_code: NSString, ) -> LanguageDirection

Returns the direction of the sequence of characters in a line for the specified ISO language code.

pub fn line_direction_for_language( iso_language_code: NSString, ) -> LanguageDirection

Returns the direction of the sequence of lines for the specified ISO language code.

Methods from Deref<Target = Object>

pub fn class(&self) -> &Class

Returns the class of self.

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

where T: Encode,

Returns a reference to the ivar of self with the given name. Panics if self has no ivar with the given name. Unsafe because the caller must ensure that the ivar is actually of type T.

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

where T: Encode,

Returns a mutable reference to the ivar of self with the given name. Panics if self has no ivar with the given name. Unsafe because the caller must ensure that the ivar is actually of type T.

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

where T: Encode,

Sets the value of the ivar of self with the given name. Panics if self has no ivar with the given name. Unsafe because the caller must ensure that the ivar is actually of type T.

Trait Implementations

impl Clone for NSLocale

fn clone(&self) -> Self

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NSLocale

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

Formats the value using the given formatter.

impl Deref for NSLocale

type Target = Object

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for NSLocale

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

Mutably dereferences the value.

impl Display for NSLocale

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

Formats the value using the given formatter.

impl Encode for NSLocale

fn encode() -> Encoding

Returns the Objective-C type encoding for Self.

impl FromId for NSLocale

unsafe fn from_id(ptr: id) -> Self

Returns Self representation of the object.

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 INSLocale for NSLocale

fn m_locale_with_locale_identifier(string: &NSString) -> Self

where Self: Sized + FromId,

Returns a locale initialized using the given locale identifier.

fn m_init_with_locale_identifier( &mut self, locale_identifier: &NSString, ) -> Self

where Self: Sized + FromId,

Initializes a locale using a given locale identifier.

fn m_init_with_coder(&mut self, coder: &NSCoder) -> Self

where Self: Sized + FromId,

Returns a locale initialized from data in the given unarchiver.

fn p_autoupdating_current_locale() -> NSLocale

A locale which tracks the user’s current preferences.

fn p_current_locale() -> NSLocale

A locale representing the user’s region settings at the time the property is read.

fn p_system_locale() -> NSLocale

A locale representing the generic root values with little localization.

fn p_available_locale_identifiers() -> NSArray<NSString>

The list of locale identifiers available on the system.

fn p_iso_country_codes() -> NSArray<NSString>

The list of known country or region codes.

fn p_iso_language_codes() -> NSArray<NSString>

The list of known language codes.

fn p_iso_currency_codes() -> NSArray<NSString>

The list of known currency codes.

fn p_common_isocurrency_codes() -> NSArray<NSString>

A list of commonly encountered currency codes.

fn m_canonical_locale_identifier_from_string(string: &NSString) -> NSString

Returns the canonical identifier for a given locale identification string.

fn m_components_from_locale_identifier( string: &NSString, ) -> NSDictionary<NSString, NSString>

Returns a dictionary that is the result of parsing a locale ID.

fn m_locale_identifier_from_components( dict: &NSDictionary<NSString, NSString>, ) -> NSString

Returns a locale identifier from the components specified in a given dictionary.

fn m_canonical_language_identifier_from_string(string: &NSString) -> NSString

Returns a canonical language identifier by mapping an arbitrary locale identification string to the canonical identifier.

fn m_locale_identifier_from_windows_locale_code(lcid: u32) -> Option<NSString>

Returns a locale identifier from a Windows locale code.

fn m_windows_locale_code_from_locale_identifier( locale_identifier: &NSString, ) -> u32

Returns a Window locale code from the locale identifier.

fn p_locale_identifier(&self) -> NSString

The identifier for the locale.

fn p_country_code(&self) -> Option<NSString>

The country or region code for the locale.

fn p_language_code(&self) -> NSString

The language code for the locale.

fn p_script_code(&self) -> Option<NSString>

The script code for the locale.

fn p_variant_code(&self) -> Option<NSString>

The variant code for the locale.

fn p_exemplar_character_set(&self) -> NSCharacterSet

The exemplar character set for the locale.

fn p_collation_identifier(&self) -> Option<NSString>

The collation identifier for the locale.

fn p_collator_identifier(&self) -> NSString

The collator identifier for the locale.

fn p_uses_metric_system(&self) -> bool

A Boolean value that indicates whether the locale uses the metric system.

fn p_decimal_separator(&self) -> NSString

The decimal separator for the locale.

fn p_grouping_separator(&self) -> NSString

The grouping separator for the locale.

fn p_currency_code(&self) -> Option<NSString>

The currency code for the locale.

fn p_currency_symbol(&self) -> NSString

The currency symbol for the locale.

fn p_calendar_identifier(&self) -> NSString

The calendar identifier for the locale.

fn p_quotation_begin_delimiter(&self) -> NSString

The begin quotation symbol for the locale.

fn p_quotation_end_delimiter(&self) -> NSString

The end quotation symbol for the locale.

fn p_alternate_quotation_begin_delimiter(&self) -> NSString

The alternate begin quotation symbol for the locale.

fn p_alternate_quotation_end_delimiter(&self) -> NSString

The alternate end quotation symbol for the locale.

fn m_localized_string_for_locale_identifier( &self, locale_identifier: &NSString, ) -> NSString

Returns the localized string for the specified locale identifier.

fn m_localized_string_for_country_code( &self, country_code: &NSString, ) -> Option<NSString>

Returns the localized string for a country or region code.

fn m_localized_string_for_language_code( &self, language_code: &NSString, ) -> Option<NSString>

Returns the localized string for the specified language code.

fn m_localized_string_for_script_code( &self, script_code: &NSString, ) -> Option<NSString>

Returns the localized string for the specified script code.

fn m_localized_string_for_variant_code( &self, variant_code: &NSString, ) -> Option<NSString>

Returns the localized string for the specified variant code.

fn m_localized_string_for_collation_identifier( &self, collation_identifier: &NSString, ) -> Option<NSString>

Returns the localized string for the specified collation identifier.

fn m_localized_string_for_collator_identifier( &self, collator_identifier: &NSString, ) -> Option<NSString>

Returns the localized string for the specified collator identifier.

fn m_localized_string_for_currency_code( &self, currency_code: &NSString, ) -> Option<NSString>

Returns the localized string for the specified currency code.

fn m_localized_string_for_calendar_identifier( &self, calendar_identifier: &NSString, ) -> Option<NSString>

Returns the localized string for the specified language code.

fn m_object_for_key(&self, key: NSLocaleKey) -> Option<id>

Returns the value of the component corresponding to the specified key.

fn m_display_name_for_key_value( &self, key: NSLocaleKey, value: &NSString, ) -> Option<NSString>

Returns the display name for the given locale component value.

fn p_preferred_languages() -> NSArray<NSString>

An ordered list of the user’s preferred languages.

fn m_character_direction_for_language( iso_language_code: NSString, ) -> LanguageDirection

Returns the direction of the sequence of characters in a line for the specified ISO language code.

fn m_line_direction_for_language( iso_language_code: NSString, ) -> LanguageDirection

Returns the direction of the sequence of lines for the specified ISO language code.

impl PNSObject for NSLocale

fn m_class<'a>() -> &'a Class

Returns the class object for the receiver’s class.

fn m_self(&self) -> id

Returns the receiver.

fn m_new() -> Self

where Self: Sized + FromId,

Allocates a new instance of the receiving class, sends it an init message, and returns the initialized object.

fn m_alloc() -> Self

where Self: Sized + FromId,

Returns a new instance of the receiving class.

fn m_initialize()

Initializes the class before it receives its first message.

fn ip_superclass<'a>() -> Option<&'a Class>

Returns the class object for the receiver’s superclass.

fn m_is_equal(&self, object: &Self) -> bool

Returns a Boolean value that indicates whether the receiver and a given object are equal.

fn p_hash(&self) -> UInt

Returns an integer that can be used as a table address in a hash table structure.

fn m_is_kind_of_class(&self, class: Class) -> bool

Returns a Boolean value that indicates whether the receiver is an instance of given class or an instance of any class that inherits from that class.

fn m_is_member_of_class(&self, class: Class) -> bool

Returns a Boolean value that indicates whether the receiver is an instance of a given class.

fn m_responds_to_selector(&self, selector: Sel) -> bool

Returns a Boolean value that indicates whether the receiver implements or inherits a method that can respond to a specified message.

fn m_conforms_to_protocol(&self, protocol: Protocol) -> bool

Returns a Boolean value that indicates whether the receiver conforms to a given protocol.

fn p_description(&self) -> NSString

A textual representation of the receiver.

fn p_debug_description(&self) -> NSString

A textual representation of the receiver to use with a debugger.

fn m_perform_selector(&self, selector: Sel) -> id

Sends a specified message to the receiver and returns the result of the message.

fn m_perform_selector_with_object(&self, selector: Sel, with_object: id) -> id

Sends a message to the receiver with an object as the argument.

fn m_is_proxy(&self) -> bool

Returns a Boolean value that indicates whether the receiver does not descend from NSObject.

impl ToId for NSLocale

fn to_id(self) -> id

Returns id representation of the object.