Describes the type T
: its low-level representation, meta-data and validation rules.
Value parameters
- format
-
The name of the format of the low-level representation of
T
.
Attributes
- Companion
- object
- Graph
-
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait SchemaMacros[T]class Objecttrait Matchableclass AnyShow all
Members list
Value members
Concrete methods
Apply defined validation rules to the given value.
Apply defined validation rules to the given value.
Attributes
Apply defined validation rules to the given value.
Apply defined validation rules to the given value.
Attributes
Apply defined validation rules to the given value.
Apply defined validation rules to the given value.
Attributes
Apply defined validation rules to the given value.
Apply defined validation rules to the given value.
Attributes
Apply defined validation rules to the given value.
Apply defined validation rules to the given value.
Attributes
Apply defined validation rules to the given value.
Apply defined validation rules to the given value.
Attributes
Apply defined validation rules to the given value.
Apply defined validation rules to the given value.
Attributes
Adapt this schema to type TT
. Only the meta-data is retained, except for default values and the validator (however, product field/subtypes validators are retained). Run-time functionality:
Adapt this schema to type TT
. Only the meta-data is retained, except for default values and the validator (however, product field/subtypes validators are retained). Run-time functionality:
- traversing collection elements, product fields, or coproduct subtypes
- validating an instance of type
TT
the top-level type is lost.
Attributes
Adapt this schema to type TT
. Only the meta-data is retained, except for default values and the validator (however, product field/subtypes validators are retained). Run-time functionality:
Adapt this schema to type TT
. Only the meta-data is retained, except for default values and the validator (however, product field/subtypes validators are retained). Run-time functionality:
- traversing collection elements, product fields, or coproduct subtypes
- validating an instance of type
TT
the top-level type is lost.
Attributes
Adapt this schema to type TT
. Only the meta-data is retained, except for default values and the validator (however, product field/subtypes validators are retained). Run-time functionality:
Adapt this schema to type TT
. Only the meta-data is retained, except for default values and the validator (however, product field/subtypes validators are retained). Run-time functionality:
- traversing collection elements, product fields, or coproduct subtypes
- validating an instance of type
TT
the top-level type is lost.
Attributes
Adapt this schema to type TT
. Only the meta-data is retained, except for default values and the validator (however, product field/subtypes validators are retained). Run-time functionality:
Adapt this schema to type TT
. Only the meta-data is retained, except for default values and the validator (however, product field/subtypes validators are retained). Run-time functionality:
- traversing collection elements, product fields, or coproduct subtypes
- validating an instance of type
TT
the top-level type is lost.
Attributes
Adapt this schema to type TT
. Only the meta-data is retained, except for default values and the validator (however, product field/subtypes validators are retained). Run-time functionality:
Adapt this schema to type TT
. Only the meta-data is retained, except for default values and the validator (however, product field/subtypes validators are retained). Run-time functionality:
- traversing collection elements, product fields, or coproduct subtypes
- validating an instance of type
TT
the top-level type is lost.
Attributes
Adapt this schema to type TT
. Only the meta-data is retained, except for default values and the validator (however, product field/subtypes validators are retained). Run-time functionality:
Adapt this schema to type TT
. Only the meta-data is retained, except for default values and the validator (however, product field/subtypes validators are retained). Run-time functionality:
- traversing collection elements, product fields, or coproduct subtypes
- validating an instance of type
TT
the top-level type is lost.
Attributes
Adapt this schema to type TT
. Only the meta-data is retained, except for default values and the validator (however, product field/subtypes validators are retained). Run-time functionality:
Adapt this schema to type TT
. Only the meta-data is retained, except for default values and the validator (however, product field/subtypes validators are retained). Run-time functionality:
- traversing collection elements, product fields, or coproduct subtypes
- validating an instance of type
TT
the top-level type is lost.
Attributes
Returns an array version of this schema, with the schema type wrapped in SArray. Sets isOptional
to true as the collection might be empty.
Returns an array version of this schema, with the schema type wrapped in SArray. Sets isOptional
to true as the collection might be empty.
Attributes
Returns an array version of this schema, with the schema type wrapped in SArray. Sets isOptional
to true as the collection might be empty.
Returns an array version of this schema, with the schema type wrapped in SArray. Sets isOptional
to true as the collection might be empty.
Attributes
Returns an array version of this schema, with the schema type wrapped in SArray. Sets isOptional
to true as the collection might be empty.
Returns an array version of this schema, with the schema type wrapped in SArray. Sets isOptional
to true as the collection might be empty.
Attributes
Returns an array version of this schema, with the schema type wrapped in SArray. Sets isOptional
to true as the collection might be empty.
Returns an array version of this schema, with the schema type wrapped in SArray. Sets isOptional
to true as the collection might be empty.
Attributes
Returns an array version of this schema, with the schema type wrapped in SArray. Sets isOptional
to true as the collection might be empty.
Returns an array version of this schema, with the schema type wrapped in SArray. Sets isOptional
to true as the collection might be empty.
Attributes
Returns an array version of this schema, with the schema type wrapped in SArray. Sets isOptional
to true as the collection might be empty.
Returns an array version of this schema, with the schema type wrapped in SArray. Sets isOptional
to true as the collection might be empty.
Attributes
Returns an array version of this schema, with the schema type wrapped in SArray. Sets isOptional
to true as the collection might be empty.
Returns an array version of this schema, with the schema type wrapped in SArray. Sets isOptional
to true as the collection might be empty.
Attributes
Returns a collection version of this schema, with the schema type wrapped in SArray. Sets isOptional
to true as the collection might be empty.
Returns a collection version of this schema, with the schema type wrapped in SArray. Sets isOptional
to true as the collection might be empty.
Attributes
Returns a collection version of this schema, with the schema type wrapped in SArray. Sets isOptional
to true as the collection might be empty.
Returns a collection version of this schema, with the schema type wrapped in SArray. Sets isOptional
to true as the collection might be empty.
Attributes
Returns a collection version of this schema, with the schema type wrapped in SArray. Sets isOptional
to true as the collection might be empty.
Returns a collection version of this schema, with the schema type wrapped in SArray. Sets isOptional
to true as the collection might be empty.
Attributes
Returns a collection version of this schema, with the schema type wrapped in SArray. Sets isOptional
to true as the collection might be empty.
Returns a collection version of this schema, with the schema type wrapped in SArray. Sets isOptional
to true as the collection might be empty.
Attributes
Returns a collection version of this schema, with the schema type wrapped in SArray. Sets isOptional
to true as the collection might be empty.
Returns a collection version of this schema, with the schema type wrapped in SArray. Sets isOptional
to true as the collection might be empty.
Attributes
Returns a collection version of this schema, with the schema type wrapped in SArray. Sets isOptional
to true as the collection might be empty.
Returns a collection version of this schema, with the schema type wrapped in SArray. Sets isOptional
to true as the collection might be empty.
Attributes
Returns a collection version of this schema, with the schema type wrapped in SArray. Sets isOptional
to true as the collection might be empty.
Returns a collection version of this schema, with the schema type wrapped in SArray. Sets isOptional
to true as the collection might be empty.
Attributes
Returns an optional version of this schema, with isOptional
set to true.
Returns an optional version of this schema, with isOptional
set to true.
Attributes
Returns an optional version of this schema, with isOptional
set to true.
Returns an optional version of this schema, with isOptional
set to true.
Attributes
Returns an optional version of this schema, with isOptional
set to true.
Returns an optional version of this schema, with isOptional
set to true.
Attributes
Returns an optional version of this schema, with isOptional
set to true.
Returns an optional version of this schema, with isOptional
set to true.
Attributes
Returns an optional version of this schema, with isOptional
set to true.
Returns an optional version of this schema, with isOptional
set to true.
Attributes
Returns an optional version of this schema, with isOptional
set to true.
Returns an optional version of this schema, with isOptional
set to true.
Attributes
Returns an optional version of this schema, with isOptional
set to true.
Returns an optional version of this schema, with isOptional
set to true.
Attributes
Adds a default value, which is used by Codec s during decoding and for documentation.
Adds a default value, which is used by Codec s during decoding and for documentation.
To represent the value in the documentation, an encoded form needs to be provided. The encoded form is inferred if missing and the given value is of a basic type (number, string, etc.).
Attributes
Adds a default value, which is used by Codec s during decoding and for documentation.
Adds a default value, which is used by Codec s during decoding and for documentation.
To represent the value in the documentation, an encoded form needs to be provided. The encoded form is inferred if missing and the given value is of a basic type (number, string, etc.).
Attributes
Adds a default value, which is used by Codec s during decoding and for documentation.
Adds a default value, which is used by Codec s during decoding and for documentation.
To represent the value in the documentation, an encoded form needs to be provided. The encoded form is inferred if missing and the given value is of a basic type (number, string, etc.).
Attributes
Adds a default value, which is used by Codec s during decoding and for documentation.
Adds a default value, which is used by Codec s during decoding and for documentation.
To represent the value in the documentation, an encoded form needs to be provided. The encoded form is inferred if missing and the given value is of a basic type (number, string, etc.).
Attributes
Adds a default value, which is used by Codec s during decoding and for documentation.
Adds a default value, which is used by Codec s during decoding and for documentation.
To represent the value in the documentation, an encoded form needs to be provided. The encoded form is inferred if missing and the given value is of a basic type (number, string, etc.).
Attributes
Adds a default value, which is used by Codec s during decoding and for documentation.
Adds a default value, which is used by Codec s during decoding and for documentation.
To represent the value in the documentation, an encoded form needs to be provided. The encoded form is inferred if missing and the given value is of a basic type (number, string, etc.).
Attributes
Adds a default value, which is used by Codec s during decoding and for documentation.
Adds a default value, which is used by Codec s during decoding and for documentation.
To represent the value in the documentation, an encoded form needs to be provided. The encoded form is inferred if missing and the given value is of a basic type (number, string, etc.).
Attributes
Add a validator to this schema. If the validator contains a named enum validator:
Add a validator to this schema. If the validator contains a named enum validator:
- the encode function is inferred if not yet defined, and the validators possible values are of a basic type
- the name is set as the schema's name.
Attributes
Add a validator to this schema. If the validator contains a named enum validator:
Add a validator to this schema. If the validator contains a named enum validator:
- the encode function is inferred if not yet defined, and the validators possible values are of a basic type
- the name is set as the schema's name.
Attributes
Add a validator to this schema. If the validator contains a named enum validator:
Add a validator to this schema. If the validator contains a named enum validator:
- the encode function is inferred if not yet defined, and the validators possible values are of a basic type
- the name is set as the schema's name.
Attributes
Add a validator to this schema. If the validator contains a named enum validator:
Add a validator to this schema. If the validator contains a named enum validator:
- the encode function is inferred if not yet defined, and the validators possible values are of a basic type
- the name is set as the schema's name.
Attributes
Add a validator to this schema. If the validator contains a named enum validator:
Add a validator to this schema. If the validator contains a named enum validator:
- the encode function is inferred if not yet defined, and the validators possible values are of a basic type
- the name is set as the schema's name.
Attributes
Add a validator to this schema. If the validator contains a named enum validator:
Add a validator to this schema. If the validator contains a named enum validator:
- the encode function is inferred if not yet defined, and the validators possible values are of a basic type
- the name is set as the schema's name.
Attributes
Add a validator to this schema. If the validator contains a named enum validator:
Add a validator to this schema. If the validator contains a named enum validator:
- the encode function is inferred if not yet defined, and the validators possible values are of a basic type
- the name is set as the schema's name.
Attributes
Inherited methods
Modifies nested schemas for case classes and case class families (sealed traits / enums), accessible with path
, using the given modification
function. To traverse collections, use .each
.
Modifies nested schemas for case classes and case class families (sealed traits / enums), accessible with path
, using the given modification
function. To traverse collections, use .each
.
Should only be used if the schema hasn't been created by .map
ping another one. In such a case, the shape of the schema doesn't correspond to the type T
, but to some lower-level representation of the type.
If the shape of the schema doesn't correspond to the path, the schema remains unchanged.
Attributes
- Inherited from:
- SchemaMacros
Modifies nested schemas for case classes and case class families (sealed traits / enums), accessible with path
, using the given modification
function. To traverse collections, use .each
.
Modifies nested schemas for case classes and case class families (sealed traits / enums), accessible with path
, using the given modification
function. To traverse collections, use .each
.
Should only be used if the schema hasn't been created by .map
ping another one. In such a case, the shape of the schema doesn't correspond to the type T
, but to some lower-level representation of the type.
If the shape of the schema doesn't correspond to the path, the schema remains unchanged.
Attributes
- Inherited from:
- SchemaMacros
Modifies nested schemas for case classes and case class families (sealed traits / enums), accessible with path
, using the given modification
function. To traverse collections, use .each
.
Modifies nested schemas for case classes and case class families (sealed traits / enums), accessible with path
, using the given modification
function. To traverse collections, use .each
.
Should only be used if the schema hasn't been created by .map
ping another one. In such a case, the shape of the schema doesn't correspond to the type T
, but to some lower-level representation of the type.
If the shape of the schema doesn't correspond to the path, the schema remains unchanged.
Attributes
- Inherited from:
- SchemaMacros
Modifies nested schemas for case classes and case class families (sealed traits / enums), accessible with path
, using the given modification
function. To traverse collections, use .each
.
Modifies nested schemas for case classes and case class families (sealed traits / enums), accessible with path
, using the given modification
function. To traverse collections, use .each
.
Should only be used if the schema hasn't been created by .map
ping another one. In such a case, the shape of the schema doesn't correspond to the type T
, but to some lower-level representation of the type.
If the shape of the schema doesn't correspond to the path, the schema remains unchanged.
Attributes
- Inherited from:
- SchemaMacros
Modifies nested schemas for case classes and case class families (sealed traits / enums), accessible with path
, using the given modification
function. To traverse collections, use .each
.
Modifies nested schemas for case classes and case class families (sealed traits / enums), accessible with path
, using the given modification
function. To traverse collections, use .each
.
Should only be used if the schema hasn't been created by .map
ping another one. In such a case, the shape of the schema doesn't correspond to the type T
, but to some lower-level representation of the type.
If the shape of the schema doesn't correspond to the path, the schema remains unchanged.
Attributes
- Inherited from:
- SchemaMacros
Modifies nested schemas for case classes and case class families (sealed traits / enums), accessible with path
, using the given modification
function. To traverse collections, use .each
.
Modifies nested schemas for case classes and case class families (sealed traits / enums), accessible with path
, using the given modification
function. To traverse collections, use .each
.
Should only be used if the schema hasn't been created by .map
ping another one. In such a case, the shape of the schema doesn't correspond to the type T
, but to some lower-level representation of the type.
If the shape of the schema doesn't correspond to the path, the schema remains unchanged.
Attributes
- Inherited from:
- SchemaMacros
Modifies nested schemas for case classes and case class families (sealed traits / enums), accessible with path
, using the given modification
function. To traverse collections, use .each
.
Modifies nested schemas for case classes and case class families (sealed traits / enums), accessible with path
, using the given modification
function. To traverse collections, use .each
.
Should only be used if the schema hasn't been created by .map
ping another one. In such a case, the shape of the schema doesn't correspond to the type T
, but to some lower-level representation of the type.
If the shape of the schema doesn't correspond to the path, the schema remains unchanged.
Attributes
- Inherited from:
- SchemaMacros
Attributes
- Inherited from:
- Product
Attributes
- Inherited from:
- Product
Attributes
- Inherited from:
- Product
Attributes
- Inherited from:
- Product
Attributes
- Inherited from:
- Product
Attributes
- Inherited from:
- Product
Attributes
- Inherited from:
- Product
Attributes
- Inherited from:
- Product
Attributes
- Inherited from:
- Product
Attributes
- Inherited from:
- Product
Attributes
- Inherited from:
- Product
Attributes
- Inherited from:
- Product
Attributes
- Inherited from:
- Product
Attributes
- Inherited from:
- Product