Struct CollatorOptions 

pub struct CollatorOptions { /* private fields */ }

Options for Intl.Collator and String.prototype.localeCompare.

MDN documentation

Implementations

impl CollatorOptions

pub fn get_locale_matcher(&self) -> Option<LocaleMatcher>

impl CollatorOptions

pub fn set_locale_matcher(&self, value: LocaleMatcher)

impl CollatorOptions

pub fn get_usage(&self) -> Option<CollatorUsage>

impl CollatorOptions

pub fn set_usage(&self, value: CollatorUsage)

impl CollatorOptions

pub fn get_sensitivity(&self) -> Option<CollatorSensitivity>

impl CollatorOptions

pub fn set_sensitivity(&self, value: CollatorSensitivity)

impl CollatorOptions

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

impl CollatorOptions

pub fn set_ignore_punctuation(&self, value: bool)

impl CollatorOptions

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

impl CollatorOptions

pub fn set_numeric(&self, value: bool)

impl CollatorOptions

pub fn get_case_first(&self) -> Option<CollatorCaseFirst>

impl CollatorOptions

pub fn set_case_first(&self, value: CollatorCaseFirst)

impl CollatorOptions

pub fn new() -> CollatorOptions

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

fn as_ref(&self) -> &CollatorOptions

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

impl AsRef<CollatorOptions> for ResolvedCollatorOptions

fn as_ref(&self) -> &CollatorOptions

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

impl AsRef<JsValue> for CollatorOptions

fn as_ref(&self) -> &JsValue

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

impl AsRef<Object> for CollatorOptions

fn as_ref(&self) -> &Object

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

impl Clone for CollatorOptions

fn clone(&self) -> CollatorOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CollatorOptions

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

Formats the value using the given formatter.

impl Default for CollatorOptions

fn default() -> CollatorOptions

Returns the “default value” for a type.

impl Deref for CollatorOptions

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Object

Dereferences the value.

impl ErasableGeneric for CollatorOptions

type Repr = JsValue

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

impl From<CollatorOptions> for JsValue

fn from(obj: CollatorOptions) -> JsValue

Converts to this type from the input type.

impl From<CollatorOptions> for Object

fn from(obj: CollatorOptions) -> Object

Converts to this type from the input type.

impl From<JsValue> for CollatorOptions

fn from(obj: JsValue) -> CollatorOptions

Converts to this type from the input type.

impl From<ResolvedCollatorOptions> for CollatorOptions

fn from(obj: ResolvedCollatorOptions) -> CollatorOptions

Converts to this type from the input type.

impl FromWasmAbi for CollatorOptions

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: <CollatorOptions as FromWasmAbi>::Abi) -> CollatorOptions

Recover a Self from Self::Abi.

impl IntoJsGeneric for CollatorOptions

where CollatorOptions: JsGeneric,

type JsCanon = CollatorOptions

The canonical JsGeneric form of this type.

fn to_js(self) -> CollatorOptions

Produce the canonical JsGeneric value for self.

impl IntoWasmAbi for CollatorOptions

type Abi = <JsValue as IntoWasmAbi>::Abi

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

fn into_abi(self) -> <CollatorOptions as IntoWasmAbi>::Abi

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

impl<'__wbg_ref> IntoWasmAbi for &'__wbg_ref CollatorOptions

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

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

fn into_abi(self) -> <&'__wbg_ref CollatorOptions as IntoWasmAbi>::Abi

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

impl JsCast for CollatorOptions

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

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

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

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 CollatorOptions

type Abi = <JsValue as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi

type Anchor = CollatorOptions

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi( js: <CollatorOptions as LongRefFromWasmAbi>::Abi, ) -> <CollatorOptions as LongRefFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl NullableFromWasmAbi for CollatorOptions

fn is_null(abi: &<CollatorOptions as MaybeFromWasmAbi>::MaybeAbi) -> bool

Tests the ABI value for Nullable::Null.

impl NullableIntoWasmAbi for CollatorOptions

fn null() -> <CollatorOptions as MaybeIntoWasmAbi>::MaybeAbi

Returns the ABI value for Nullable::Null, which JS reads as null.

impl<'__wbg_ref> NullableIntoWasmAbi for &'__wbg_ref CollatorOptions

fn null() -> <&'__wbg_ref CollatorOptions as MaybeIntoWasmAbi>::MaybeAbi

Returns the ABI value for Nullable::Null, which JS reads as null.

impl OptionFromWasmAbi for CollatorOptions

fn is_none(abi: &<CollatorOptions as FromWasmAbi>::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 OptionIntoWasmAbi for CollatorOptions

fn none() -> <CollatorOptions as IntoWasmAbi>::Abi

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

impl<'__wbg_ref> OptionIntoWasmAbi for &'__wbg_ref CollatorOptions

fn none() -> <&'__wbg_ref CollatorOptions as IntoWasmAbi>::Abi

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

impl Promising for CollatorOptions

type Resolution = CollatorOptions

The type that this value resolves to.

impl RefFromWasmAbi for CollatorOptions

type Abi = <JsValue as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<CollatorOptions>

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: <CollatorOptions as RefFromWasmAbi>::Abi, ) -> <CollatorOptions as RefFromWasmAbi>::Anchor

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

impl UpcastFrom<CollatorOptions> for JsValue

impl UpcastFrom<CollatorOptions> for JsOption

impl UpcastFrom<CollatorOptions> for JsNullable

impl<__UpcastWrapTarget> UpcastFrom<CollatorOptions> for Option<__UpcastWrapTarget>

where __UpcastWrapTarget: UpcastFrom<CollatorOptions>,

impl<__UpcastWrapTarget> UpcastFrom<CollatorOptions> for Nullable<__UpcastWrapTarget>

where __UpcastWrapTarget: UpcastFrom<CollatorOptions>,

impl UpcastFrom<CollatorOptions> for CollatorOptions

impl UpcastFrom<CollatorOptions> for JsOption<CollatorOptions>

impl UpcastFrom<CollatorOptions> for JsNullable<CollatorOptions>

impl UpcastFrom<CollatorOptions> for Object

impl UpcastFrom<CollatorOptions> for JsOption<Object>

impl UpcastFrom<CollatorOptions> for JsNullable<Object>

impl UpcastFrom<ResolvedCollatorOptions> for CollatorOptions

impl VectorRefIntoWasmAbi for CollatorOptions

fn slice_into_abi(slice: &[CollatorOptions]) -> WasmSlice