Struct Locale 

pub struct Locale { /* private fields */ }

The Intl.Locale object is a standard built-in property of the Intl object that represents a Unicode locale identifier.

MDN documentation

Implementations

impl Locale

pub fn new(tag: &str) -> Result<Locale, JsValue>

Creates a new Intl.Locale object.

MDN documentation

impl Locale

pub fn new_with_options(tag: &str, options: &Object) -> Result<Locale, JsValue>

Creates a new Intl.Locale object with options.

MDN documentation

impl Locale

pub fn base_name(&self) -> JsString

The base name of the locale (language + region + script).

MDN documentation

impl Locale

pub fn calendar(&self) -> Option<JsString>

The calendar type for the locale.

MDN documentation

impl Locale

pub fn case_first(&self) -> Option<JsString>

The case first sorting option.

MDN documentation

impl Locale

pub fn collation(&self) -> Option<JsString>

The collation type for the locale.

MDN documentation

impl Locale

pub fn hour_cycle(&self) -> Option<JsString>

The hour cycle for the locale.

MDN documentation

impl Locale

pub fn language(&self) -> JsString

The language code for the locale.

MDN documentation

impl Locale

pub fn numbering_system(&self) -> Option<JsString>

The numbering system for the locale.

MDN documentation

impl Locale

pub fn numeric(&self) -> bool

Whether the locale uses numeric collation.

MDN documentation

impl Locale

pub fn region(&self) -> Option<JsString>

The region code for the locale.

MDN documentation

impl Locale

pub fn script(&self) -> Option<JsString>

The script code for the locale.

MDN documentation

impl Locale

pub fn get_calendars(&self) -> Array<JsString>

Returns an array of available calendars for the locale.

MDN documentation

impl Locale

pub fn get_collations(&self) -> Array<JsString>

Returns an array of available collations for the locale.

MDN documentation

impl Locale

pub fn get_hour_cycles(&self) -> Array<JsString>

Returns an array of available hour cycles for the locale.

MDN documentation

impl Locale

pub fn get_numbering_systems(&self) -> Array<JsString>

Returns an array of available numbering systems for the locale.

MDN documentation

impl Locale

pub fn get_time_zones(&self) -> Option<Array<JsString>>

Returns an array of available time zones for the locale’s region.

MDN documentation

impl Locale

pub fn get_week_info(&self) -> Result<WeekInfo, JsValue>

Returns week information for the locale.

May not be available in all environments.

MDN documentation

impl Locale

pub fn get_text_info(&self) -> Result<TextInfo, JsValue>

Returns text layout information for the locale.

May not be available in all environments.

MDN documentation

impl Locale

pub fn maximize(&self) -> Locale

Returns a new Locale with the specified calendar.

MDN documentation

impl Locale

pub fn minimize(&self) -> Locale

Returns a new Locale with the minimal subtags.

MDN documentation

Methods from Deref<Target = Object>

pub fn constructor(&self) -> Function

The constructor property returns a reference to the Object constructor function that created the instance object.

MDN documentation

pub fn has_own_property(&self, property: &JsValue) -> bool

👎Deprecated: Use Object::hasOwn instead.

The hasOwnProperty() method returns a boolean indicating whether the object has the specified property as its own property (as opposed to inheriting it).

MDN documentation

pub fn is_prototype_of(&self, value: &JsValue) -> bool

The isPrototypeOf() method checks if an object exists in another object’s prototype chain.

MDN documentation

pub fn property_is_enumerable(&self, property: &JsValue) -> bool

The propertyIsEnumerable() method returns a Boolean indicating whether the specified property is enumerable.

MDN documentation

pub fn to_locale_string(&self) -> JsString

The toLocaleString() method returns a string representing the object. This method is meant to be overridden by derived objects for locale-specific purposes.

MDN documentation

pub fn to_string(&self) -> JsString

The toString() method returns a string representing the object.

MDN documentation

pub fn to_js_string(&self) -> JsString

The toString() method returns a string representing the object.

MDN documentation

pub fn value_of(&self) -> Object

The valueOf() method returns the primitive value of the specified object.

MDN documentation

Methods from Deref<Target = JsValue>

pub const NULL: JsValue

pub const UNDEFINED: JsValue

pub const TRUE: JsValue

pub const FALSE: JsValue

pub fn as_f64(&self) -> Option<f64>

Returns the f64 value of this JS value if it’s an instance of a number.

If this JS value is not an instance of a number then this returns None.

pub fn is_string(&self) -> bool

Tests whether this JS value is a JS string.

pub fn as_string(&self) -> Option<String>

If this JS value is a string value, this function copies the JS string value into Wasm linear memory, encoded as UTF-8, and returns it as a Rust String.

To avoid the copying and re-encoding, consider the JsString::try_from() function from js-sys instead.

If this JS value is not an instance of a string or if it’s not valid utf-8 then this returns None.

UTF-16 vs UTF-8

JavaScript strings in general are encoded as UTF-16, but Rust strings are encoded as UTF-8. This can cause the Rust string to look a bit different than the JS string sometimes. For more details see the documentation about the str type which contains a few caveats about the encodings.

pub fn as_bool(&self) -> Option<bool>

Returns the bool value of this JS value if it’s an instance of a boolean.

If this JS value is not an instance of a boolean then this returns None.

pub fn is_null(&self) -> bool

Tests whether this JS value is null

pub fn is_undefined(&self) -> bool

Tests whether this JS value is undefined

pub fn is_null_or_undefined(&self) -> bool

Tests whether this JS value is null or undefined

pub fn is_symbol(&self) -> bool

Tests whether the type of this JS value is symbol

pub fn is_object(&self) -> bool

Tests whether typeof self == "object" && self !== null.

pub fn is_array(&self) -> bool

Tests whether this JS value is an instance of Array.

pub fn is_function(&self) -> bool

Tests whether the type of this JS value is function.

pub fn is_bigint(&self) -> bool

Tests whether the type of this JS value is bigint.

pub fn js_typeof(&self) -> JsValue

Applies the unary typeof JS operator on a JsValue.

MDN documentation

pub fn js_in(&self, obj: &JsValue) -> bool

Applies the binary in JS operator on the two JsValues.

MDN documentation

pub fn is_truthy(&self) -> bool

Tests whether the value is “truthy”.

pub fn is_falsy(&self) -> bool

Tests whether the value is “falsy”.

pub fn loose_eq(&self, other: &JsValue) -> bool

Compare two JsValues for equality, using the == operator in JS.

MDN documentation

pub fn bit_not(&self) -> JsValue

Applies the unary ~ JS operator on a JsValue.

MDN documentation

pub fn unsigned_shr(&self, rhs: &JsValue) -> u32

Applies the binary >>> JS operator on the two JsValues.

MDN documentation

pub fn checked_div(&self, rhs: &JsValue) -> JsValue

Applies the binary / JS operator on two JsValues, catching and returning any RangeError thrown.

MDN documentation

pub fn pow(&self, rhs: &JsValue) -> JsValue

Applies the binary ** JS operator on the two JsValues.

MDN documentation

pub fn lt(&self, other: &JsValue) -> bool

Applies the binary < JS operator on the two JsValues.

MDN documentation

pub fn le(&self, other: &JsValue) -> bool

Applies the binary <= JS operator on the two JsValues.

MDN documentation

pub fn ge(&self, other: &JsValue) -> bool

Applies the binary >= JS operator on the two JsValues.

MDN documentation

pub fn gt(&self, other: &JsValue) -> bool

Applies the binary > JS operator on the two JsValues.

MDN documentation

pub fn unchecked_into_f64(&self) -> f64

Applies the unary + JS operator on a JsValue. Can throw.

MDN documentation

Trait Implementations

impl AsRef<JsValue> for Locale

fn as_ref(&self) -> &JsValue

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

impl AsRef<Locale> for Locale

fn as_ref(&self) -> &Locale

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

impl AsRef<Object> for Locale

fn as_ref(&self) -> &Object

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

impl Clone for Locale

fn clone(&self) -> Locale

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Locale

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

Formats the value using the given formatter.

impl Deref for Locale

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Object

Dereferences the value.

impl ErasableGeneric for Locale

type Repr = JsValue

The singular concrete type that all generic variants can be transmuted on

impl From<JsValue> for Locale

fn from(obj: JsValue) -> Self

Converts to this type from the input type.

impl From<Locale> for JsValue

fn from(obj: Locale) -> JsValue

Converts to this type from the input type.

impl From<Locale> for Object

fn from(obj: Locale) -> Object

Converts to this type from the input type.

impl FromWasmAbi for Locale

type Abi = <JsValue as FromWasmAbi>::Abi

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl<'a> IntoWasmAbi for &'a Locale

type Abi = <&'a JsValue as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl IntoWasmAbi for Locale

type Abi = <JsValue as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl JsCast for Locale

fn instanceof(val: &JsValue) -> bool

Performs a dynamic instanceof check to see whether the JsValue provided is an instance of this type.

fn unchecked_from_js(val: JsValue) -> Self

Performs a zero-cost unchecked conversion from a JsValue into an instance of Self

fn unchecked_from_js_ref(val: &JsValue) -> &Self

Performs a zero-cost unchecked conversion from a &JsValue into an instance of &Self.

fn has_type<T>(&self) -> bool

where T: JsCast,

Test whether this JS value has a type T.

fn dyn_into<T>(self) -> Result<T, Self>

where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn dyn_ref<T>(&self) -> Option<&T>

where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn unchecked_into<T>(self) -> T

where T: JsCast,

Performs a zero-cost unchecked cast into the specified type.

fn unchecked_ref<T>(&self) -> &T

where T: JsCast,

Performs a zero-cost unchecked cast into a reference to the specified type.

fn is_instance_of<T>(&self) -> bool

where T: JsCast,

Test whether this JS value is an instance of the type T.

fn is_type_of(val: &JsValue) -> bool

Performs a dynamic check to see whether the JsValue provided is a value of this type.

impl LongRefFromWasmAbi for Locale

type Abi = <JsValue as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi

type Anchor = Locale

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for Locale

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl<'a> OptionIntoWasmAbi for &'a Locale

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl OptionIntoWasmAbi for Locale

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl Promising for Locale

type Resolution = Locale

The type that this value resolves to.

impl RefFromWasmAbi for Locale

type Abi = <JsValue as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<Locale>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl WasmDescribe for Locale

fn describe()

impl UpcastFrom<Locale> for JsOption<Locale>

impl UpcastFrom<Locale> for JsOption<Object>

impl UpcastFrom<Locale> for JsValue

impl UpcastFrom<Locale> for Locale

impl UpcastFrom<Locale> for Object