Enum matrix_sdk_base::ruma::JsOption

source ·
pub enum JsOption<T> {
    Some(T),
    Null,
    Undefined,
}
Expand description

An Option-like type with two data-less variants in addition to Some: Null and Undefined.

Variants§

§

Some(T)

Some value T

§

Null

Explicit absence of a value

§

Undefined

Implicit absence of a value

Implementations§

source§

impl<T> JsOption<T>

source

pub fn from_option(opt: Option<T>) -> JsOption<T>

Construct a JsOption from a regular Option.

None will be converted to to Null.

source

pub fn from_implicit_option(opt: Option<T>) -> JsOption<T>

Construct a JsOption from a regular Option.

None will be converted to Undefined.

source

pub fn into_option(self) -> Option<T>

Convert a JsOption to Option.

source

pub fn into_nested_option(self) -> Option<Option<T>>

Convert a JsOption<T> to Option<Option<T>>.

Null is represented as Some(None) while Undefined is represented as None.

source

pub const fn is_some(&self) -> bool

Returns true if the JsOption contains a value.

source

pub const fn is_null(&self) -> bool

Returns true if the JsOption is Null.

source

pub const fn is_undefined(&self) -> bool

Returns true if the JsOption is Undefined.

source

pub fn unwrap(self) -> T

Returns the contained Some value, consuming the self value.

§Panics

Panics if the self value equals Null or Undefined.

source

pub fn unwrap_or(self, default: T) -> T

Returns the contained Some value or a provided default.

source

pub fn unwrap_or_else<F>(self, f: F) -> T
where F: FnOnce() -> T,

Returns the contained Some value computes is from a closure.

source

pub fn map<U, F>(self, f: F) -> JsOption<U>
where F: FnOnce(T) -> U,

Maps a JsOption<T> to JsOption<U> by applying a function to a contained value.

source

pub const fn as_ref(&self) -> JsOption<&T>

Converts from &Option<T> to Option<&T>.

source

pub fn as_mut(&mut self) -> JsOption<&mut T>

Converts from &mut Option<T> to Option<&mut T>.

source§

impl<T> JsOption<T>
where T: Default,

source

pub fn unwrap_or_default(self) -> T

Returns the contained Some value or a default.

source§

impl<T> JsOption<T>
where T: Deref,

source

pub fn as_deref(&self) -> JsOption<&<T as Deref>::Target>

Converts from &JsOption<T> to JsOption<&T::Target>.

source§

impl<T> JsOption<T>
where T: DerefMut,

source

pub fn as_deref_mut(&mut self) -> JsOption<&mut <T as Deref>::Target>

Converts from &mut JsOption<T> to JsOption<&mut T::Target>.

Trait Implementations§

source§

impl<T> Clone for JsOption<T>
where T: Clone,

source§

fn clone(&self) -> JsOption<T>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<T> Debug for JsOption<T>
where T: Debug,

source§

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

Formats the value using the given formatter. Read more
source§

impl<T> Default for JsOption<T>

source§

fn default() -> JsOption<T>

Returns the default value, JsOption::Undefined.

source§

impl<'de, T> Deserialize<'de> for JsOption<T>
where T: Deserialize<'de>,

source§

fn deserialize<D>( deserializer: D, ) -> Result<JsOption<T>, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

Deserialize a JsOption.

This implementation will never return Undefined. You need to use #[serde(default)] to get Undefined when the field is not present.

source§

impl<T> Hash for JsOption<T>
where T: Hash,

source§

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<T> Ord for JsOption<T>
where T: Ord,

source§

fn cmp(&self, other: &JsOption<T>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl<T> PartialEq for JsOption<T>
where T: PartialEq,

source§

fn eq(&self, other: &JsOption<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<T> PartialOrd for JsOption<T>
where T: PartialOrd,

source§

fn partial_cmp(&self, other: &JsOption<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl<T> Serialize for JsOption<T>
where T: Serialize,

source§

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize a JsOption.

Serialization will fail for JsOption::Undefined. You need to use #[skip_serializing_if = "JsOption::is_undefined"] to stop the field from being serialized altogether.

source§

impl<T> Copy for JsOption<T>
where T: Copy,

source§

impl<T> Eq for JsOption<T>
where T: Eq,

source§

impl<T> StructuralPartialEq for JsOption<T>

Auto Trait Implementations§

§

impl<T> Freeze for JsOption<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for JsOption<T>
where T: RefUnwindSafe,

§

impl<T> Send for JsOption<T>
where T: Send,

§

impl<T> Sync for JsOption<T>
where T: Sync,

§

impl<T> Unpin for JsOption<T>
where T: Unpin,

§

impl<T> UnwindSafe for JsOption<T>
where T: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> CloneToUninit for T
where T: Copy,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

source§

const WITNESS: W = W::MAKE

A constant of the type witness
source§

impl<T> Identity for T
where T: ?Sized,

§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> AsyncTraitDeps for T

source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

source§

impl<T> SendOutsideWasm for T
where T: Send,

source§

impl<T> SyncOutsideWasm for T
where T: Sync,