p

zio

schema

package schema

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. schema
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Package Members

  1. package annotation
  2. package codec
  3. package diff
  4. package meta
  5. package validation

Type Members

  1. trait AccessorBuilder extends AnyRef
  2. sealed trait Append[EnumType, -Left, -Right] extends AnyRef
  3. trait AppendLowPriority extends AppendLowPriority2
  4. trait AppendLowPriority2 extends AnyRef
  5. sealed trait CaseSet extends AnyRef
  6. trait Differ[A] extends AnyRef
  7. sealed trait DynamicValue extends AnyRef
  8. sealed trait FieldSet extends AnyRef
  9. trait MutableSchemaBasedValueBuilder[Target, Context] extends AnyRef

    Base trait for mutable builders producing a value based on a schema, such as codec decoders.

    Base trait for mutable builders producing a value based on a schema, such as codec decoders.

    The implementation is stack safe and consists of a series of invocations of the protected methods the trait defines. Maintaining the state of the builder, such as stream position etc. is the responsibility of the implementation class via mutable state.

    The Target type parameter is the base type for the generated values - this in many cases can be Any but potentially could be used to track errors in value level as well - although failure in the context handler manipulation methods cannot be expressed this way.

    The Context type parameter is a use-case dependent type that is managed in a stack during the execution of the builder. The implementation can generate new context values for the value's subtrees and it can be used to track local state required for gathering all information for the value to be created. The current context value is also propagated to any exception thrown so it can be used to provide detailed location information for decoder errors.

  10. trait MutableSchemaBasedValueProcessor[Target, Context] extends AnyRef

    Base trait for mutable value processors, processing a value with a known schema.

    Base trait for mutable value processors, processing a value with a known schema. An example is protocol encoders.

    The implementation is stack safe and consists of invocations of a series of processXYZ methods, as well as built-in support for a context value which is handled in a stacked way.

    Maintaining any global state (per process) such as stream writers etc. is the responsibility of the implementation class.

    The Target type parameter is the base type for the process function's output value. In case the process is built entirely using side effects (such as calls to a mutable writer interface) this type can be Unit.

    The Context type parameter is the use-case specific context type which is passed for each process invocation, and can be manipulated before each process call achieving a local state.

  11. sealed trait Patch[A] extends AnyRef
  12. sealed trait Schema[A] extends AnyRef

    A Schema[A] describes the structure of some data type A, in terms of case classes, enumerations (sealed traits), collections, and various primitive types (including not only Scala's own primitive types, but enhanced with java.time and big integers / decimals).

    A Schema[A] describes the structure of some data type A, in terms of case classes, enumerations (sealed traits), collections, and various primitive types (including not only Scala's own primitive types, but enhanced with java.time and big integers / decimals).

    Schemas models the structure of data types as first class values, so they can be introspected, transformed, and combined using ordinary Scala code, without macros, metaprogramming, or codegen.

    There are implicit schemas provided for all standard Scala types, and you can automatically derive schemas for your own data types by using DeriveSchema.gen[A]. Whether you write them by hand by using constructors and operators,

    final case class Person(name: String, age: Int)
    object Person {
      implicit val personSchema: Schema[Person] = DeriveSchema.gen[Person]
    }
  13. trait SchemaEquality extends AnyRef
  14. trait SchemaSyntax extends AnyRef
  15. trait SimpleMutableSchemaBasedValueBuilder[Target] extends MutableSchemaBasedValueBuilder[Target, Unit]

    A simpler version of SimpleMutableSchemaBasedValueBuilder without using any Context

  16. trait SimpleMutableSchemaBasedValueProcessor[Target] extends MutableSchemaBasedValueProcessor[Target, Unit]

    A simpler version of MutableSchemaBasedValueProcessor without using any Context

  17. type Singleton = scala.Singleton
  18. sealed trait StandardType[A] extends Ordering[A]
  19. sealed trait TypeId extends AnyRef

Value Members

  1. object Append extends AppendLowPriority
  2. object CaseSet
  3. object Cons0
  4. object Differ
  5. object DynamicValue
  6. object FieldSet
  7. object MutableSchemaBasedValueBuilder
  8. object Patch
  9. object Schema extends SchemaEquality
  10. object SchemaOrdering
  11. object StandardType extends Serializable
  12. object TypeId
  13. object syntax extends SchemaSyntax

Inherited from AnyRef

Inherited from Any

Ungrouped