Skip to main content

DocumentValidator

Struct DocumentValidator 

Source
pub struct DocumentValidator { /* private fields */ }
Available on crate feature validation only.
Expand description

Validates create documents for one resource.

Implementations§

Source§

impl DocumentValidator

Source

pub fn for_create(schema: &ResourceSchema) -> Result<Self, BuildError>

Available on crate feature domain only.

Derive a create-body validator from an ash-domain schema.

The ash-domain shortcut for DocumentValidator::builder: attribute types come from ResourceSchema::to_json_schema, and the members JSON:API carries elsewhere are hidden — the primary key, which belongs in the envelope, and every relationship’s foreign key, which belongs in linkage.

Note what hiding does and does not do. hide removes a property from the generated schema, so the member is no longer described; it does not set additionalProperties: false, so it is not forbidden either. Sending a hidden member is therefore not an error — it is ignored. What keeps it from taking effect is the reading side: Mounted’s document reader skips the primary key, so a client cannot choose a row’s id by sending attributes.id.

Relationships are optional in the document: whether one is required is a domain policy, not a question about the document’s shape.

Source§

impl DocumentValidator

Source

pub fn builder<S: ResourceDef>(schema: &S) -> ValidatorBuilder<'_, S>

Start building a validator for schema.

Source

pub fn parse( &self, body: &str, ctx: &Context, ) -> Result<Value, Vec<JsonApiError>>

Parse a raw body and check it in one step.

The usual entry point: a body that is not JSON at all is a 422 like any other malformed document, so a handler has one failure path rather than two.

Source

pub fn check( &self, body: &Value, ctx: &Context, ) -> Result<(), Vec<JsonApiError>>

Check one request body.

Every failure becomes a JSON:API error carrying the pointer at the member that caused it and the request’s correlation id.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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