Enum matrix_sdk::ruma::JsOption
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§
Implementations§
§impl<T> JsOption<T>
impl<T> JsOption<T>
pub fn from_option(opt: Option<T>) -> JsOption<T>
pub fn from_option(opt: Option<T>) -> JsOption<T>
Construct a JsOption
from a regular Option
.
None
will be converted to to Null
.
pub fn from_implicit_option(opt: Option<T>) -> JsOption<T>
pub fn from_implicit_option(opt: Option<T>) -> JsOption<T>
Construct a JsOption
from a regular Option
.
None
will be converted to Undefined
.
pub fn into_option(self) -> Option<T>
pub fn into_option(self) -> Option<T>
Convert a JsOption
to Option
.
pub fn into_nested_option(self) -> Option<Option<T>>
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
.
pub const fn is_undefined(&self) -> bool
pub const fn is_undefined(&self) -> bool
Returns true
if the JsOption
is Undefined
.
pub fn unwrap(self) -> T
pub fn unwrap(self) -> T
Returns the contained Some
value, consuming the self
value.
§Panics
Panics if the self value equals Null
or Undefined
.
pub fn unwrap_or(self, default: T) -> T
pub fn unwrap_or(self, default: T) -> T
Returns the contained Some
value or a provided default.
pub fn unwrap_or_else<F>(self, f: F) -> Twhere
F: FnOnce() -> T,
pub fn unwrap_or_else<F>(self, f: F) -> Twhere
F: FnOnce() -> T,
Returns the contained Some
value computes is from a closure.
§impl<T> JsOption<T>where
T: Default,
impl<T> JsOption<T>where
T: Default,
pub fn unwrap_or_default(self) -> T
pub fn unwrap_or_default(self) -> T
Returns the contained Some
value or a default.
Trait Implementations§
§impl<'de, T> Deserialize<'de> for JsOption<T>where
T: Deserialize<'de>,
impl<'de, T> Deserialize<'de> for JsOption<T>where
T: Deserialize<'de>,
§fn deserialize<D>(
deserializer: D
) -> Result<JsOption<T>, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
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.
§impl<T> Ord for JsOption<T>where
T: Ord,
impl<T> Ord for JsOption<T>where
T: Ord,
§impl<T> PartialEq for JsOption<T>where
T: PartialEq,
impl<T> PartialEq for JsOption<T>where
T: PartialEq,
§impl<T> PartialOrd for JsOption<T>where
T: PartialOrd,
impl<T> PartialOrd for JsOption<T>where
T: PartialOrd,
§fn partial_cmp(&self, other: &JsOption<T>) -> Option<Ordering>
fn partial_cmp(&self, other: &JsOption<T>) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read more§impl<T> Serialize for JsOption<T>where
T: Serialize,
impl<T> Serialize for JsOption<T>where
T: Serialize,
§fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
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.
impl<T> Copy for JsOption<T>where
T: Copy,
impl<T> Eq for JsOption<T>where
T: Eq,
impl<T> StructuralPartialEq for JsOption<T>
Auto Trait Implementations§
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
§impl<T> CompatExt for T
impl<T> CompatExt for T
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.§impl<T> FutureExt for T
impl<T> FutureExt for T
§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
§impl<T, UT> HandleAlloc<UT> for T
impl<T, UT> HandleAlloc<UT> for T
§fn new_handle(value: Arc<T>) -> Handle
fn new_handle(value: Arc<T>) -> Handle
§fn clone_handle(handle: Handle) -> Handle
fn clone_handle(handle: Handle) -> Handle
§fn consume_handle(handle: Handle) -> Arc<T>
fn consume_handle(handle: Handle) -> Arc<T>
Arc<>
§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<R, P> ReadPrimitive<R> for P
impl<R, P> ReadPrimitive<R> for P
source§fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
ReadEndian::read_from_little_endian()
.