Enum schemars::schema::SingleOrVec

pub enum SingleOrVec<T> {
    Single(Box<T>),
    Vec(Vec<T>),
}

A type which can be serialized as a single item, or multiple items.

In some contexts, a Single may be semantically distinct from a Vec containing only item.

Variants

Single(Box<T>)

Vec(Vec<T>)

Implementations

impl<T: PartialEq> SingleOrVec<T>

pub fn contains(&self, x: &T) -> bool

Returns true if self is either a Single equal to x, or a Vec containing x.

Examples

use schemars::schema::SingleOrVec;

let s = SingleOrVec::from(10);
assert!(s.contains(&10));
assert!(!s.contains(&20));

let v = SingleOrVec::from(vec![10, 20]);
assert!(v.contains(&10));
assert!(v.contains(&20));
assert!(!v.contains(&30));

Trait Implementations

impl<T: Clone> Clone for SingleOrVec<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for SingleOrVec<T>

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

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.

impl<T> From<T> for SingleOrVec<T>

fn from(single: T) -> Self

Converts to this type from the input type.

impl<T> From<Vec<T, Global>> for SingleOrVec<T>

fn from(vec: Vec<T>) -> Self

Converts to this type from the input type.

impl<T: JsonSchema> JsonSchema for SingleOrVec<T>

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl<T: Ord> Ord for SingleOrVec<T>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<SingleOrVec<T>> for SingleOrVec<T>

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

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

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.

impl<T: PartialOrd> PartialOrd<SingleOrVec<T>> for SingleOrVec<T>

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<T> Serialize for SingleOrVec<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: Eq> Eq for SingleOrVec<T>

impl<T> StructuralEq for SingleOrVec<T>

impl<T> StructuralPartialEq for SingleOrVec<T>