Enum OptionalVec

Source
pub enum OptionalVec<T> {
    NotPresent,
    One(Option<T>),
    Many(Vec<T>),
}
Expand description

A rather complicated relative of Option<Vec>

There are a couple places in JSON:API where you have keys with values that can either:

  • Not Exist
  • Be null
  • Contain a single object
  • Contain an array of objects

This enum exists for those cases

OptionalVec::NotPresent exists to specify that the key should not (or did not) exist

OptionalVec::One is None when the value is null and Some when there is a single object

OptionalVec::Many will be used when the value is an array, empty or not

Variants§

§

NotPresent

§

One(Option<T>)

§

Many(Vec<T>)

Implementations§

Source§

impl<T> OptionalVec<T>

Source

pub fn is_not_present(&self) -> bool

Checks for the OptionalVec::NotPresent variant

Mostly provided to allow serialization to be skipped

Source

pub fn is_one(&self) -> bool

Checks for the OptionalVec::One variant

Source

pub fn is_many(&self) -> bool

Checks for the OptionalVec::Many variant

Source

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

Map each contained value with the given function

Source

pub fn one_or<E>(self, e: E) -> Result<Option<T>, E>

Error with e if Many, else build an Option

Source

pub fn many_or<E>(self, e: E) -> Result<Vec<T>, E>

Return the contents of Many, else error with e

Source

pub fn into_vec(self) -> Vec<T>

Return all contained items as a Vec

Will map OptionalVec::One(Some(v)) into vec![v]

Source

pub fn unwrap_one(self) -> T

Unwraps One(Some(v))

§Panics

Panics for all other variants

Source

pub fn unwrap_many(self) -> Vec<T>

Unwraps Many(v)

§Panics

Panics for all other variants

Trait Implementations§

Source§

impl<T: Clone> Clone for OptionalVec<T>

Source§

fn clone(&self) -> OptionalVec<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> Debug for OptionalVec<T>

Source§

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

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

impl<T> Default for OptionalVec<T>

Defaults to OptionalVec::NotPresent

Source§

fn default() -> Self

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

impl<'de, T> Deserialize<'de> for OptionalVec<T>

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<T: PartialEq> PartialEq for OptionalVec<T>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

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

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl<T: Eq> Eq for OptionalVec<T>

Source§

impl<T> StructuralPartialEq for OptionalVec<T>

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

impl<T> UnwindSafe for OptionalVec<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 = 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>,

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.
Source§

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