Skip to main content

Schema

Struct Schema 

Source
pub struct Schema { /* private fields */ }
Expand description

Composes fields and layout blocks and resolves every field once into one list.

Implementations§

Source§

impl Schema

Source

pub fn is_empty(&self) -> bool

Reports whether this schema declares nothing to render.

Source

pub fn new(children: impl IntoSchema) -> Self

Builds a Schema from any IntoSchema and reports duplicate field names as declaration errors.

Source

pub fn empty() -> Self

Source

pub fn fields(&self) -> impl Iterator<Item = &Field>

Every field, in declaration order.

Source

pub async fn render<'a>( &self, cx: &'a Cx, source: Source<'_>, ) -> Result<BoxView<'a>>

Renders the schema from source and fails with declaration errors instead of rendering.

§Errors

A misdeclared schema fails with its errors rather than render.

Source

pub fn normalize_values(&self, values: &mut HashMap<String, String>)

Rewrites submitted values into their fields’ stored spelling and leaves empty submissions empty for the presence rule to refuse.

Source

pub fn extend(self, other: Schema) -> Schema

Appends another schema’s nodes after this one’s.

Source

pub fn unknown_keys(&self, values: &HashMap<String, String>) -> Vec<String>

Lists keys in values that no declared input owns, sorted, so handlers reject client-controlled writes.

Source

pub fn declaration_errors(&self) -> Vec<DeclarationErrorKind>

Reports what is wrong with this declaration: a field whose lens binds no single column, and two fields sharing a name.

Source

pub fn validate(&self, values: &HashMap<String, String>) -> FieldErrors

Validates submitted values against declared inputs, treating absent keys as empty and skipping fields in absent repeater groups and hidden variant groups.

Source

pub async fn validate_async( &self, cx: &Cx, values: &HashMap<String, String>, ) -> FieldErrors

Validates submissions and then probes each visible choice’s option existence.

Trait Implementations§

Source§

impl Debug for Schema

Source§

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

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

impl Default for Schema

Source§

fn default() -> Self

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

impl IntoSchema 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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