Struct TypeContract 

pub struct TypeContract {
    pub name: &'static str,
    /* private fields */
}

One type this crate declares, with its schema and its canonical values.

Fields

name: &'static str

The type’s own name, which is also its schema’s file name.

Implementations

impl TypeContract

pub fn of<T: Sample + JsonSchema + Serialize + DeserializeOwned>( name: &'static str, ) -> Self

The contract of one type, under the name its schema is written under.

This is how a crate other than this one declares a type of its own into the schema set: its schemas test lists its types through this and reconciles the files under schemas/<crate>/ against them, walking the same round trip and the same absent-optional rule this crate’s own contract tests walk.

pub fn schema(&self) -> Value

The JSON Schema this type emits.

pub fn full(&self) -> Value

A serialized value carrying every field the type declares.

pub fn minimal(&self) -> Value

A serialized value carrying every optional field absent.

pub fn samples(&self) -> Vec<Value>

Every canonical value of this type: the full one, the minimal one, and one per further arm of a union.

pub fn round_trip(&self, value: Value) -> Result<Value, String>

Parse a value as this type and serialize the result back.

Errors

Returns the parse or emission failure, as the message it carried.

Trait Implementations

impl Clone for TypeContract

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TypeContract

impl Debug for TypeContract

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

Formats the value using the given formatter.