nori - v1.1.0

nori/builder/schema_builder

Builder for constructing JSON Schema objects with a fluent API.

Types

SchemaBuilder

opaque </>

Builder for creating JSON Schema objects.

pub opaque type SchemaBuilder

Values

additional_properties

</> 
pub fn additional_properties(
  builder: SchemaBuilder,
) -> SchemaBuilder

Allows additional properties of any type.

additional_properties_schema

</> 
pub fn additional_properties_schema(
  builder: SchemaBuilder,
  s: schema.Schema,
) -> SchemaBuilder

Sets additional properties schema.

all_of

</> 
pub fn all_of(
  builder: SchemaBuilder,
  schemas: List(reference.Ref(schema.Schema)),
) -> SchemaBuilder

Adds an allOf schema.

any_of

</> 
pub fn any_of(
  builder: SchemaBuilder,
  schemas: List(reference.Ref(schema.Schema)),
) -> SchemaBuilder

Adds an anyOf schema.

array

</> 
pub fn array() -> SchemaBuilder

Creates an array schema.

boolean

</> 
pub fn boolean() -> SchemaBuilder

Creates a boolean schema.

build

</> 
pub fn build(builder: SchemaBuilder) -> schema.Schema

Builds the schema.

build_ref

</> 
pub fn build_ref(
  builder: SchemaBuilder,
) -> reference.Ref(schema.Schema)

Builds the schema as a Ref.

const_value

</> 
pub fn const_value(
  builder: SchemaBuilder,
  value: json.Json,
) -> SchemaBuilder

Sets a const value.

default

</> 
pub fn default(
  builder: SchemaBuilder,
  d: json.Json,
) -> SchemaBuilder

Sets the default value.

deprecated

</> 
pub fn deprecated(builder: SchemaBuilder) -> SchemaBuilder

Marks as deprecated.

description

</> 
pub fn description(
  builder: SchemaBuilder,
  d: String,
) -> SchemaBuilder

Sets the description.

enum_values

</> 
pub fn enum_values(
  builder: SchemaBuilder,
  values: List(json.Json),
) -> SchemaBuilder

Sets enum values.

example

</> 
pub fn example(
  builder: SchemaBuilder,
  e: json.Json,
) -> SchemaBuilder

Sets an example.

exclusive_maximum

</> 
pub fn exclusive_maximum(
  builder: SchemaBuilder,
  n: Float,
) -> SchemaBuilder

Sets exclusive maximum value.

exclusive_minimum

</> 
pub fn exclusive_minimum(
  builder: SchemaBuilder,
  n: Float,
) -> SchemaBuilder

Sets exclusive minimum value.

format

</> 
pub fn format(builder: SchemaBuilder, f: String) -> SchemaBuilder

Sets the format.

integer

</> 
pub fn integer() -> SchemaBuilder

Creates an integer schema.

items

</> 
pub fn items(
  builder: SchemaBuilder,
  items_schema: schema.Schema,
) -> SchemaBuilder

Sets items schema for arrays.

items_ref

</> 
pub fn items_ref(
  builder: SchemaBuilder,
  ref: String,
) -> SchemaBuilder

Sets items schema reference for arrays.

max_items

</> 
pub fn max_items(builder: SchemaBuilder, n: Int) -> SchemaBuilder

Sets maximum items for arrays.

max_length

</> 
pub fn max_length(
  builder: SchemaBuilder,
  n: Int,
) -> SchemaBuilder

Sets maximum length for strings.

max_properties

</> 
pub fn max_properties(
  builder: SchemaBuilder,
  n: Int,
) -> SchemaBuilder

Sets maximum properties.

maximum

</> 
pub fn maximum(builder: SchemaBuilder, n: Float) -> SchemaBuilder

Sets maximum value.

min_items

</> 
pub fn min_items(builder: SchemaBuilder, n: Int) -> SchemaBuilder

Sets minimum items for arrays.

min_length

</> 
pub fn min_length(
  builder: SchemaBuilder,
  n: Int,
) -> SchemaBuilder

Sets minimum length for strings.

min_properties

</> 
pub fn min_properties(
  builder: SchemaBuilder,
  n: Int,
) -> SchemaBuilder

Sets minimum properties.

minimum

</> 
pub fn minimum(builder: SchemaBuilder, n: Float) -> SchemaBuilder

Sets minimum value.

multiple_of

</> 
pub fn multiple_of(
  builder: SchemaBuilder,
  n: Float,
) -> SchemaBuilder

Sets multiple of.

new

</> 
pub fn new() -> SchemaBuilder

Creates a new schema builder.

no_additional_properties

</> 
pub fn no_additional_properties(
  builder: SchemaBuilder,
) -> SchemaBuilder

Disallows additional properties.

not

</> 
pub fn not(
  builder: SchemaBuilder,
  s: reference.Ref(schema.Schema),
) -> SchemaBuilder

Sets a not schema.

null

</> 
pub fn null() -> SchemaBuilder

Creates a null schema.

nullable

</> 
pub fn nullable(builder: SchemaBuilder) -> SchemaBuilder

Creates a nullable type (e.g., [“string”, “null”]).

number

</> 
pub fn number() -> SchemaBuilder

Creates a number schema.

object

</> 
pub fn object() -> SchemaBuilder

Creates an object schema.

one_of

</> 
pub fn one_of(
  builder: SchemaBuilder,
  schemas: List(reference.Ref(schema.Schema)),
) -> SchemaBuilder

Adds a oneOf schema.

pattern

</> 
pub fn pattern(
  builder: SchemaBuilder,
  p: String,
) -> SchemaBuilder

Sets pattern for strings.

property

</> 
pub fn property(
  builder: SchemaBuilder,
  name: String,
  prop_schema: schema.Schema,
) -> SchemaBuilder

Adds a property to the object schema.

property_ref

</> 
pub fn property_ref(
  builder: SchemaBuilder,
  name: String,
  ref: String,
) -> SchemaBuilder

Adds a property reference to the object schema.

read_only

</> 
pub fn read_only(builder: SchemaBuilder) -> SchemaBuilder

Marks as read-only.

required

</> 
pub fn required(
  builder: SchemaBuilder,
  names: List(String),
) -> SchemaBuilder

Marks properties as required.

required_property

</> 
pub fn required_property(
  builder: SchemaBuilder,
  name: String,
  prop_schema: schema.Schema,
) -> SchemaBuilder

Adds a required property to the object schema.

required_property_ref

</> 
pub fn required_property_ref(
  builder: SchemaBuilder,
  name: String,
  ref: String,
) -> SchemaBuilder

Adds a required property reference to the object schema.

string

</> 
pub fn string() -> SchemaBuilder

Creates a string schema.

title

</> 
pub fn title(builder: SchemaBuilder, t: String) -> SchemaBuilder

Sets the title.

unique_items

</> 
pub fn unique_items(builder: SchemaBuilder) -> SchemaBuilder

Sets unique items for arrays.

write_only

</> 
pub fn write_only(builder: SchemaBuilder) -> SchemaBuilder

Marks as write-only.

✨ Search Document