Struct vector_config :: schema :: SchemaGenerator Copy item path

impl SchemaGenerator

pub fn new(settings: SchemaSettings) -> SchemaGenerator

Creates a new SchemaGenerator using the given settings.

pub fn settings(&self) -> &SchemaSettings

Gets the SchemaSettings being used by this SchemaGenerator.

pub fn definitions(&self) -> &BTreeMap<String, Schema>

Borrows the collection of all referenceable schemas that have been generated.

The keys of the returned Map are the schema names, and the values are the schemas themselves.

pub fn definitions_mut(&mut self) -> &mut BTreeMap<String, Schema>

Mutably borrows the collection of all referenceable schemas that have been generated.

The keys of the returned Map are the schema names, and the values are the schemas themselves.

pub fn dereference<'a>(&'a self, schema: &Schema) -> Option<&'a Schema>

Attempts to find the schema that the given schema is referencing.

If the given schema has a $ref property which refers to another schema in self’s schema definitions, the referenced schema will be returned. Otherwise, returns None.

pub fn into_root_schema(self, root_schema: SchemaObject) -> RootSchema

Converts this generator into a root schema, using the given root_schema as the top-level definition.

This assumes the root schema was generated using this generator, such that any schema definitions referenced by root_schema refer to this generator.

All other relevant settings (i.e. meta-schema) are carried over.

Trait Implementations§

impl Debug for SchemaGenerator

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

Formats the value using the given formatter. Read more

impl Default for SchemaGenerator

fn default() -> SchemaGenerator

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

impl From<SchemaSettings> for SchemaGenerator

fn from(settings: SchemaSettings) -> SchemaGenerator

Converts to this type from the input type.

Auto Trait Implementations§

impl !UnwindSafe for SchemaGenerator

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<Source, Target> OctetsInto<Target> for Source
where Target: OctetsFrom<Source>,

type Error = <Target as OctetsFrom<Source>>::Error

fn try_octets_into( self, ) -> Result<Target, <Source as OctetsInto<Target>>::Error>

Performs the conversion.

fn octets_into(self) -> Target
where Self::Error: Into<Infallible>,

Performs an infallible conversion.

impl<D> OwoColorize for D

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

Set the foreground color generically Read more

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

Set the background color generically. Read more

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

Change the foreground color to black

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

Change the background color to black

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

Change the foreground color to red

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

Change the background color to red

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

Change the foreground color to green

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

Change the background color to green

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

Change the foreground color to yellow

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

Change the background color to yellow

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

Change the foreground color to blue

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

Change the background color to blue

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

Change the foreground color to magenta

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

Change the background color to magenta

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

Change the foreground color to purple

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

Change the background color to purple

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

Change the foreground color to cyan

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

Change the background color to cyan

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

Change the foreground color to white

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

Change the background color to white

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

Change the foreground color to the terminal default

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

Change the background color to the terminal default

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

Change the foreground color to bright black

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

Change the background color to bright black

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

Change the foreground color to bright red

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

Change the background color to bright red

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

Change the foreground color to bright green

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

Change the background color to bright green

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

Change the foreground color to bright yellow

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

Change the background color to bright yellow

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

Change the foreground color to bright blue

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

Change the background color to bright blue

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

Change the foreground color to bright magenta

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

Change the background color to bright magenta

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

Change the foreground color to bright purple

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

Change the background color to bright purple

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

Change the foreground color to bright cyan

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

Change the background color to bright cyan

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

Change the foreground color to bright white

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

Change the background color to bright white

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

Make the text bold

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

Make the text dim

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

Make the text italicized

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

Make the text underlined

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

Make the text blink

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

Make the text blink (but fast!)

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

Swap the foreground and background colors

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

Hide the text

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

Cross out the text

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

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

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.

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.

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

Sets the foreground color to an RGB value.

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

Sets the background color to an RGB value.

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

Apply a runtime-determined style

fn if_supports_color<'a, Out, ApplyFn>( &'a self, stream: impl Into<Stream>, apply: ApplyFn, ) -> SupportsColorsDisplay<'a, Self, Out, ApplyFn>
where ApplyFn: Fn(&'a Self) -> Out,

Apply a given transformation function to all formatters if the given stream supports at least basic ANSI colors, allowing you to conditionally apply given styles/colors. Read more