zio.blocks.schema.SchemaAspect
See theSchemaAspect companion trait
The built-in aspects. Apply one with Schema#@@.
Attributes
Companion
trait
Source
SchemaAspect.scala
Graph
Reset zoom Hide graph Show graph
Supertypes
trait Matchable
class Any
Self type
Members list
Creates a SchemaAspect that sets or updates the documentation string of the schema representation.
Creates a SchemaAspect that sets or updates the documentation string of the schema representation.
Value parameters
value
The documentation string.
Attributes
Returns
A SchemaAspect that, when applied, associates the given documentation string with the schema.
Source
SchemaAspect.scala
Creates a SchemaAspect that associates one or more example values with the schema for the specified type.
Creates a SchemaAspect that associates one or more example values with the schema for the specified type.
Value parameters
value
The first example value to be associated with the schema.
values
Additional example values to be associated with the schema.
Attributes
Returns
A SchemaAspect that, when applied, adds the specified example values to the schema.
Source
SchemaAspect.scala
identity is a no-op SchemaAspect that performs no transformation on the applied schema. It preserves the original structure and behaviors of the input schema without modification.
identity is a no-op SchemaAspect that performs no transformation on the applied schema. It preserves the original structure and behaviors of the input schema without modification.
Attributes
Source
SchemaAspect.scala