Struct SchemaField

pub struct SchemaField {
    pub aliases: Vec<String>,
    pub comment: Option<String>,
    pub schema: Schema,
    pub deprecated: Option<String>,
    pub env_var: Option<String>,
    pub hidden: bool,
    pub nullable: bool,
    pub optional: bool,
    pub read_only: bool,
    pub write_only: bool,
}

Describes the metadata and shape of a field within a struct or enum.

Fields

aliases: Vec<String>

comment: Option<String>

schema: Schema

deprecated: Option<String>

env_var: Option<String>

hidden: bool

nullable: bool

optional: bool

read_only: bool

write_only: bool

Implementations

impl SchemaField

pub fn new(schema: impl Into<Schema>) -> Self

Trait Implementations

impl Clone for SchemaField

fn clone(&self) -> SchemaField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaField

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

Formats the value using the given formatter.

impl Default for SchemaField

fn default() -> SchemaField

Returns the “default value” for a type.

impl From<Schema> for SchemaField

fn from(schema: Schema) -> Self

Converts to this type from the input type.

impl From<SchemaField> for Schema

fn from(val: SchemaField) -> Self

Converts to this type from the input type.

impl PartialEq for SchemaField

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Schematic for SchemaField

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.

impl StructuralPartialEq for SchemaField