Struct schematic::SchemaField

source ·

pub struct SchemaField {
    pub name: String,
    pub description: Option<String>,
    pub type_of: SchemaType,
    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,
}

Expand description

Represents a field within a schema struct, or a variant within a schema enum/union.

Fields§

§name: String§description: Option<String>§type_of: SchemaType§deprecated: Option<String>§env_var: Option<String>§hidden: bool§nullable: bool§optional: bool§read_only: bool§write_only: bool

Implementations§

source §

impl SchemaField

source

pub fn new(name: &str, type_of: SchemaType) -> SchemaField

Create a new field with the provided name and type.

Trait Implementations§

source §

impl Clone for SchemaField

source §

fn clone(&self) -> SchemaField

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

source §

impl Debug for SchemaField

source §

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

Formats the value using the given formatter. Read more

source §

impl Default for SchemaField

source §

fn default() -> SchemaField

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

Auto Trait Implementations§

§

impl UnwindSafe for SchemaField

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> DynClone for T
where T: Clone,

source §

fn __clone_box(&self, _: Private) -> *mut ()

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 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<D> OwoColorize for D

source §

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more

source §

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more

source §

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black

source §

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black

source §

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red

source §

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red

source §

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green

source §

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green

source §

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow

source §

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow

source §

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue

source §

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue

source §

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta

source §

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta

source §

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple

source §

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple

source §

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan

source §

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan

source §

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white

source §

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white

source §

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default

source §

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default

source §

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black

source §

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black

source §

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red

source §

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red

source §

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green

source §

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green

source §

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow

source §

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow

source §

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue

source §

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue

source §

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta

source §

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta

source §

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple

source §

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple

source §

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan

source §

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan

source §

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white

source §

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white

source §

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold

source §

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim

source §

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized

source §

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text italicized

source §

fn blink(&self) -> BlinkDisplay<'_, Self>

Make the text blink

source §

fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>

Make the text blink (but fast!)

source §

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors

source §

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text

source §

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text

source §

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more

source §

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more

source §

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.

source §

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.

source §

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.

source §

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.

source §

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style

source §

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.

source §

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source §

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source §

impl<T, U> TryFrom for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.

source §

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source §

impl<T, U> TryInto for T
where U: TryFrom<T>,

§

type Error = >::Error

The type returned in the event of a conversion error.

source §

fn try_into(self) -> Result<U, >::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

Struct schematic::SchemaField

Fields§

Implementations§

impl SchemaField

pub fn new(name: &str, type_of: SchemaType) -> SchemaField

Trait Implementations§

impl Clone for SchemaField

fn clone(&self) -> SchemaField

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

impl Debug for SchemaField

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

impl Default for SchemaField

fn default() -> SchemaField

Auto Trait Implementations§

impl Freeze for SchemaField

impl RefUnwindSafe for SchemaField

impl Send for SchemaField

impl Sync for SchemaField

impl Unpin for SchemaField

impl UnwindSafe for SchemaField

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> DynClone for Twhere T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where C: Color,

fn black(&self) -> FgColorDisplay<'_, Black, Self>

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

fn red(&self) -> FgColorDisplay<'_, Red, Self>

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

fn green(&self) -> FgColorDisplay<'_, Green, Self>

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

fn white(&self) -> FgColorDisplay<'_, White, Self>

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

fn bold(&self) -> BoldDisplay<'_, Self>

fn dimmed(&self) -> DimDisplay<'_, Self>

fn italic(&self) -> ItalicDisplay<'_, Self>

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> DynClone for T
where T: Clone,

impl<T, U> Into<U> for T
where U: From<T>,

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

impl<T> ToOwned for T
where T: Clone,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,