Skip to main content

Schema

Enum Schema 

Source
pub enum Schema {
Show 14 variants Boolean { constant: Option<bool>, }, Integer(IntegerSchema), String(StringSchema), Bytes { min_length: Option<usize>, max_length: Option<usize>, }, CidLink, Blob { accept: Vec<String>, max_size: Option<u64>, }, Array { items: Option<Box<Schema>>, min_length: Option<usize>, max_length: Option<usize>, }, Object(ObjectSchema), Ref(String), Union { refs: Vec<String>, closed: bool, }, Unknown, Null, Token, Unrecognised(String),
}
Expand description

One schema node.

Variants§

§

Boolean

boolean, optionally pinned to one value.

Fields

§constant: Option<bool>

The only value permitted, if the schema names one.

§

Integer(IntegerSchema)

integer.

§

String(StringSchema)

string.

§

Bytes

bytes, whose length bounds are on the decoded byte count.

Fields

§min_length: Option<usize>

Smallest permitted decoded length, in bytes.

§max_length: Option<usize>

Largest permitted decoded length, in bytes.

cid-link: {"$link": "<cid>"}.

§

Blob

blob.

Fields

§accept: Vec<String>

MIME patterns the blob’s type must match, if the schema names any.

§max_size: Option<u64>

Largest permitted size, in bytes.

§

Array

array.

Fields

§items: Option<Box<Schema>>

The element schema, if the document gave one.

§min_length: Option<usize>

Fewest permitted elements.

§max_length: Option<usize>

Most permitted elements.

§

Object(ObjectSchema)

object.

§

Ref(String)

ref: a pointer at another definition, resolved at check time.

§

Union

union: one of several referenced definitions, chosen by $type.

Fields

§refs: Vec<String>

The definitions this union admits.

§closed: bool

Whether a $type outside refs is refused. Open unions accept one, which is how a consumer survives a variant added later.

§

Unknown

unknown: any object, but an object.

§

Null

null.

§

Token

token: as a field type, a placeholder that carries no data.

§

Unrecognised(String)

A type this build does not know, which accepts anything.

Trait Implementations§

Source§

impl Clone for Schema

Source§

fn clone(&self) -> Schema

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 Debug for Schema

Source§

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

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

impl PartialEq for Schema

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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 Eq for Schema

Source§

impl StructuralPartialEq for Schema

Auto Trait Implementations§

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
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more