Enum japi::OptionalVec

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

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

Methods

impl<T> OptionalVec<T>

pub fn is_not_present(&self) -> bool

Checks for the OptionalVec::NotPresent variant

Mostly provided to allow serialization to be skipped

pub fn is_one(&self) -> bool

Checks for the OptionalVec::One variant

pub fn is_many(&self) -> bool

Checks for the OptionalVec::Many variant

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

Map each contained value with the given function

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

Error with e if Many, else build an Option

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

Return the contents of Many, else error with e

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

Return all contained items as a Vec

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

pub fn unwrap_one(self) -> T

Unwraps One(Some(v))

Panics

Panics for all other variants

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

Unwraps Many(v)

Panics

Panics for all other variants

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for OptionalVec<T>

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

Formats the value using the given formatter.

impl<T> Default for OptionalVec<T>

Defaults to OptionalVec::NotPresent

fn default() -> Self

Returns the "default value" for a type.

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

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

Deserialize this value from the given Serde deserializer.

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

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

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

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

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

This method tests for !=.

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

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

Serialize this value into the given Serde serializer.

impl<T> StructuralEq for OptionalVec<T>

impl<T> StructuralPartialEq for OptionalVec<T>