core
API
Generated with
core/smithy4s/smithy4s.schema

smithy4s.schema

package smithy4s.schema

Members list

Type members

Classlikes

final case class Alt[U, A](label: String, schema: Schema[A], inject: A => U, project: PartialFunction[U, A])

Represents a member of coproduct type (sealed trait)

Represents a member of coproduct type (sealed trait)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Alt

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Alt.type
trait CachedSchemaCompiler[+F[_]]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Impl[F]
class DerivingImpl[F]
object Decoder
class Impl[F]
object decoders
object encoders
class Uncached[F]
Show all
Self type
object CachedSchemaCompiler

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait CollectionTag[C[_]]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object IndexedSeqTag
object ListTag
object SetTag
object VectorTag
object CollectionTag

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
trait CompilationCache[F[_]]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object CompilationCache

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait EnumTag[+E]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ClosedIntEnum
class OpenIntEnum[E]
class OpenStringEnum[E]
object EnumTag

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
EnumTag.type
case class EnumValue[E](stringValue: String, intValue: Int, value: E, name: String, hints: Hints)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ErrorSchema[E]

An ErrorSchema is similar to a UnionSchema in that it exposes alternatives and ordinal values, and therefore can be manipulated similarly to UnionSchemas.

An ErrorSchema is similar to a UnionSchema in that it exposes alternatives and ordinal values, and therefore can be manipulated similarly to UnionSchemas.

Additionally, it carries functions to go from E to Throwable and vice-versa. This is used by interpreters to inject data into error channels of effect types, or to recover data from an error-channel prior to serialisation.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ErrorSchema

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class Field[S, A](label: String, schema: Schema[A], get: S => A)

Represents a member of product type (case class)

Represents a member of product type (case class)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Field

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Field.type
final case class OperationSchema[I, E, O, SI, SO]

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
class PartiallyAppliedStruct[S]

Attributes

Supertypes
class Object
trait Matchable
class Any
class PartiallyAppliedTuple

Attributes

Supertypes
class Object
trait Matchable
class Any
final class PartiallyAppliedUnion[U](val alts: Vector[Alt[U, _]]) extends AnyVal

Attributes

Supertypes
class AnyVal
trait Matchable
class Any
sealed trait Primitive[T]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object PBigDecimal
object PBigInt
object PBlob
object PBoolean
object PByte
object PDocument
object PDouble
object PFloat
object PInt
object PLong
object PShort
object PString
object PTimestamp
object PUUID
Show all
object Primitive

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Primitive.type
sealed trait Schema[A]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class BijectionSchema[A, B]
class CollectionSchema[C, A]
class LazySchema[A]
class MapSchema[K, V]
class OptionSchema[A]
class PrimitiveSchema[P]
class RefinementSchema[A, B]
class StructSchema[S]
class UnionSchema[U]
Show all
object Schema

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Schema.type
sealed trait SchemaPartition[A]

A structure indicating the match result of running Schema#partition against a given predicate

A structure indicating the match result of running Schema#partition against a given predicate

  • if the schema is not of a structure, or if none of the fields matched, then NoMatch should be returned
  • if the schema is a structure and only a subset of its fields pass the predicate, then PartialMatch should be returned
  • if the schema is a structure and all of its fields pass the predicate, then TotalMatch should be returned

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class NoMatch[A]
class SplittingMatch[A]
class TotalMatch[A]
object SchemaPartition

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
trait SchemaVisitor[F[_]] extends PolyFunction[Schema, F]

Attributes

Companion
object
Supertypes
trait PolyFunction[Schema, F]
class Object
trait Matchable
class Any
Known subtypes
class Cached[F]
trait Default[F]
trait Optional[F]
Show all
Self type
object SchemaVisitor

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
case class StreamingSchema[A](fieldName: String, schema: Schema[A])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Types

type Repr[A] = String
Generated with