Skip to main content

Nullable

Enum Nullable 

Source
pub enum Nullable<T> {
    Absent,
    Null,
    Value(T),
}
Expand description

A member that may be absent, null, or a value, keeping the three apart.

LSP and MCP use both TypeScript’s optional key?: T and nullable key: T | null, and sometimes key?: T | null, where “left out” and “null” mean different things (null often clears a setting). An Option<T> reads both as None; a Nullable<T> tells them apart, and writes back what it read: ObjectWriter::optional leaves out Absent and writes Null as null.

§Examples

use jsonx_lib::{DecodeError, FromJson, Nullable, Reader, ToJson, ValueWriter, Written};

struct Settings { tab_size: Nullable<u8> }

impl<'de> FromJson<'de> for Settings {
    fn from_json(reader: &mut Reader<'de>) -> Result<Self, DecodeError> {
        let mut tab_size = None;
        let mut o = reader.read_object()?;
        while let Some(key) = o.next_key()? {
            if key == "tabSize" { o.field(&mut tab_size)?; }
        }
        Ok(Settings { tab_size: o.required(tab_size, "tabSize")? })
    }
}

impl ToJson for Settings {
    fn to_json(&self, out: ValueWriter<'_>) -> Written {
        out.object(|o| o.optional("tabSize", &self.tab_size))
    }
}

for text in ["{}", r#"{"tabSize":null}"#, r#"{"tabSize":4}"#] {
    let s: Settings = jsonx_lib::from_str(text)?;
    assert_eq!(jsonx_lib::to_string(&s), text);
}

Variants§

§

Absent

The member is not there.

§

Null

The member is there, and null.

§

Value(T)

The member is there, with a value.

Implementations§

Source§

impl<T> Nullable<T>

Source

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

The value, if there is one: Absent and Null are both None.

§Examples
use jsonx_lib::Nullable;

assert_eq!(Nullable::Value(3).into_option(), Some(3));
assert_eq!(Nullable::<u8>::Null.into_option(), None);
Source

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

A reference to the value, if there is one.

§Examples
assert_eq!(jsonx_lib::Nullable::Value(3).as_ref(), jsonx_lib::Nullable::Value(&3));
Source

pub const fn is_null(&self) -> bool

Whether the member is there with null.

§Examples
assert!(jsonx_lib::Nullable::<u8>::Null.is_null());

Trait Implementations§

Source§

impl<T: Clone> Clone for Nullable<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Copy> Copy for Nullable<T>

Source§

impl<T: Debug> Debug for Nullable<T>

Source§

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

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

impl<T> Default for Nullable<T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<T: Eq> Eq for Nullable<T>

Source§

impl<'de, T: FromJson<'de>> FromJson<'de> for Nullable<T>

Source§

fn from_json(reader: &mut Reader<'de>) -> Result<Self, DecodeError>

Reads one value from reader, which is positioned where a value comes next. Read more
Source§

fn absent() -> Option<Self>

The value for an object member that is absent, if absence is allowed: None (absence is an error) by default, Some(None) for Option<T>, and Some(Nullable::Absent) for Nullable<T>. Read more
Source§

impl<T: Hash> Hash for Nullable<T>

Source§

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

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> Ord for Nullable<T>

Source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

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

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

fn clamp_to<R>(self, range: R) -> Self
where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)
Restrict a value to a certain range. Read more
Source§

impl<T: PartialEq> PartialEq for Nullable<T>

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<T: PartialOrd> PartialOrd for Nullable<T>

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<T: PartialEq> StructuralPartialEq for Nullable<T>

Source§

impl<T: ToJson> ToJson for Nullable<T>

Source§

fn to_json(&self, out: ValueWriter<'_>) -> Written

Writes self as one JSON value.
Source§

fn is_absent(&self) -> bool

Whether ObjectWriter::optional leaves this member out. false, except for Option<T>, where it is is_none(), and the pointer types, which ask what they point to. Read more

Auto Trait Implementations§

§

impl<T> Forget for Nullable<T>

§

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

§

impl<T> Move for Nullable<T>

§

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

§

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

§

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

§

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

§

impl<T> UnsafeUnpin for Nullable<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for Nullable<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§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

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>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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.