Struct BooleanSchema 

#[non_exhaustive]
pub struct BooleanSchema {
    pub type_: BooleanTypeConst,
    pub title: Option<Cow<'static, str>>,
    pub description: Option<Cow<'static, str>>,
    pub default: Option<bool>,
}

Schema definition for boolean properties.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

type_: BooleanTypeConst

Type discriminator

title: Option<Cow<'static, str>>

Optional title for the schema

description: Option<Cow<'static, str>>

Human-readable description

default: Option<bool>

Default value

Implementations

impl BooleanSchema

pub fn new() -> BooleanSchema

Create a new boolean schema

pub fn title(self, title: impl Into<Cow<'static, str>>) -> BooleanSchema

Set title

pub fn description( self, description: impl Into<Cow<'static, str>>, ) -> BooleanSchema

Set description

pub fn with_default(self, default: bool) -> BooleanSchema

Set default value

Trait Implementations

impl Clone for BooleanSchema

fn clone(&self) -> BooleanSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BooleanSchema

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

Formats the value using the given formatter.

impl Default for BooleanSchema

fn default() -> BooleanSchema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BooleanSchema

fn deserialize<__D>( __deserializer: __D, ) -> Result<BooleanSchema, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for BooleanSchema

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for BooleanSchema

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for BooleanSchema

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BooleanSchema