Skip to main content

Schematic

Trait Schematic

pub trait Schematic {
    // Provided methods
    fn schema_name() -> Option<String> { ... }
    fn build_schema(schema: SchemaBuilder) -> Schema { ... }
}

Expand description

Defines a schema that represents the shape of the implementing type.

Provided Methods§

fn schema_name() -> Option<String>

Define a name for this schema type. Names are required for non-primitive values as a means to link references, and avoid cycles.

fn build_schema(schema: SchemaBuilder) -> Schema

Create and return a schema that models the structure of the implementing type. The schema can be used to generate code, documentation, or other artifacts.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types§

impl Schematic for &Path

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for &RelativePath

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for &str

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for ()

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for Days

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for Decimal

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for Duration

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for IpAddr

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for Ipv4Addr

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for Ipv6Addr

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for IsoWeek

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for Mapping

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for Months

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for NaiveDate

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for NaiveDateTime

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for NaiveTime

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for NaiveWeek

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for NonZero<i8>

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for NonZero<i16>

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for NonZero<i32>

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for NonZero<i64>

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for NonZero<i128>

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for NonZero<isize>

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for NonZero<u8>

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for NonZero<u16>

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for NonZero<u32>

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for NonZero<u64>

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for NonZero<u128>

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for NonZero<usize>

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for Number

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for Number

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for Path

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for PathBuf

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for PklValue

impl Schematic for Regex

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for RelativePath

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for RelativePathBuf

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for SocketAddr

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for SocketAddrV4

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for SocketAddrV6

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for String

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for SystemTime

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for TimeDelta

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for Url

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for Uuid

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for Value

impl Schematic for Value

impl Schematic for Value

impl Schematic for Value

impl Schematic for Version

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for VersionReq

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for bool

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for char

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for f32

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for f64

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for i8

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for i16

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for i32

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for i64

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for i128

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for isize

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for str

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for u8

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for u16

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for u32

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for u64

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for u128

fn build_schema(schema: SchemaBuilder) -> Schema

impl Schematic for usize

fn build_schema(schema: SchemaBuilder) -> Schema

impl<K, V, S> Schematic for HashMap<K, V, S>
where K: Schematic, V: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<K, V> Schematic for BTreeMap<K, V>
where K: Schematic, V: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<K, V> Schematic for Map<K, V>
where K: Schematic, V: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<K, V> Schematic for Map<K, V>
where K: Schematic, V: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12> Schematic for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12)
where T0: Schematic, T1: Schematic, T2: Schematic, T3: Schematic, T4: Schematic, T5: Schematic, T6: Schematic, T7: Schematic, T8: Schematic, T9: Schematic, T10: Schematic, T11: Schematic, T12: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11> Schematic for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)
where T0: Schematic, T1: Schematic, T2: Schematic, T3: Schematic, T4: Schematic, T5: Schematic, T6: Schematic, T7: Schematic, T8: Schematic, T9: Schematic, T10: Schematic, T11: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10> Schematic for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)
where T0: Schematic, T1: Schematic, T2: Schematic, T3: Schematic, T4: Schematic, T5: Schematic, T6: Schematic, T7: Schematic, T8: Schematic, T9: Schematic, T10: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9> Schematic for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9)
where T0: Schematic, T1: Schematic, T2: Schematic, T3: Schematic, T4: Schematic, T5: Schematic, T6: Schematic, T7: Schematic, T8: Schematic, T9: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T0, T1, T2, T3, T4, T5, T6, T7, T8> Schematic for (T0, T1, T2, T3, T4, T5, T6, T7, T8)
where T0: Schematic, T1: Schematic, T2: Schematic, T3: Schematic, T4: Schematic, T5: Schematic, T6: Schematic, T7: Schematic, T8: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T0, T1, T2, T3, T4, T5, T6, T7> Schematic for (T0, T1, T2, T3, T4, T5, T6, T7)
where T0: Schematic, T1: Schematic, T2: Schematic, T3: Schematic, T4: Schematic, T5: Schematic, T6: Schematic, T7: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T0, T1, T2, T3, T4, T5, T6> Schematic for (T0, T1, T2, T3, T4, T5, T6)
where T0: Schematic, T1: Schematic, T2: Schematic, T3: Schematic, T4: Schematic, T5: Schematic, T6: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T0, T1, T2, T3, T4, T5> Schematic for (T0, T1, T2, T3, T4, T5)
where T0: Schematic, T1: Schematic, T2: Schematic, T3: Schematic, T4: Schematic, T5: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T0, T1, T2, T3, T4> Schematic for (T0, T1, T2, T3, T4)
where T0: Schematic, T1: Schematic, T2: Schematic, T3: Schematic, T4: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T0, T1, T2, T3> Schematic for (T0, T1, T2, T3)
where T0: Schematic, T1: Schematic, T2: Schematic, T3: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T0, T1, T2> Schematic for (T0, T1, T2)
where T0: Schematic, T1: Schematic, T2: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T0, T1> Schematic for (T0, T1)
where T0: Schematic, T1: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T0> Schematic for (T0,)
where T0: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T, S> Schematic for HashSet<T, S>
where T: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T, S> Schematic for IndexSet<T, S>
where T: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T, const N: usize> Schematic for [T; N]
where T: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T> Schematic for &T
where T: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T> Schematic for &[T]
where T: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T> Schematic for &mut T
where T: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T> Schematic for Arc<T>
where T: Schematic + ?Sized,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T> Schematic for BTreeSet<T>
where T: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T> Schematic for BinaryHeap<T>
where T: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T> Schematic for Box<T>
where T: Schematic + ?Sized,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T> Schematic for Cow<'_, T>
where T: Schematic + ToOwned + ?Sized,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T> Schematic for LinkedList<T>
where T: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T> Schematic for Option<T>
where T: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T> Schematic for Range<T>
where T: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T> Schematic for RangeInclusive<T>
where T: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T> Schematic for Rc<T>
where T: Schematic + ?Sized,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T> Schematic for Vec<T>
where T: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T> Schematic for VecDeque<T>
where T: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<T> Schematic for [T]
where T: Schematic,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<Tz> Schematic for Date<Tz>
where Tz: TimeZone,

fn build_schema(schema: SchemaBuilder) -> Schema

impl<Tz> Schematic for DateTime<Tz>
where Tz: TimeZone,

fn build_schema(schema: SchemaBuilder) -> Schema

Implementors§

impl Schematic for ExtendsFrom

impl Schematic for RegexSetting

Available on crate feature schema only.

impl Schematic for Schema

impl Schematic for SchemaField

impl Schematic for SchemaType

impl Schematic for VersionSetting

Available on crate feature schema only.

impl<K, V, S> Schematic for IndexMap<K, V, S>
where K: Schematic, V: Schematic,