Packages

package codecs

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

Type Members

  1. type BlobDecoder[A] = Decoder[[β$0$]Either[PayloadError, β$0$], Blob, A]
  2. type BlobEncoder[A] = Encoder[Blob, A]
  3. trait Decoder[F[_], -In, A] extends AnyRef

    An abstraction that codifies the action of reading data from some input.

  4. trait Encoder[+Out, -A] extends AnyRef

    An abstraction that codifies the notion of transforming a piece of data into some output.

  5. type PayloadDecoder[A] = Decoder[[β$1$]Either[PayloadError, β$1$], Blob, A]
  6. type PayloadEncoder[A] = Encoder[Blob, A]
  7. case class PayloadError(path: PayloadPath, expected: String, message: String) extends Throwable with NoStackTrace with Product with Serializable
  8. case class PayloadPath(segments: List[Segment]) extends Product with Serializable
  9. trait Writer[Message, -A] extends AnyRef

    An abstraction that codifies the notion of modifying a message with some additional information.

    An abstraction that codifies the notion of modifying a message with some additional information.

    This has two input channels: * one for the message that is being modified (Message) * one for the actual data (A)

    This is particularly useful for http requests/responses, where different subsets of data have a different impact on different locations of the http message : some fields may impact headers, some fields may impact the http body, other things that are driven from static information (smithy traits) may lead to a transformation of the message.

    Having the ability to decompose the notion of encoding a piece of data into different writers that can be composed together is powerful and helps centralising some complexity in third-party agnostic code.

Value Members

  1. object BlobDecoder
  2. object BlobEncoder
  3. object Decoder
  4. object Encoder
  5. object PayloadDecoder
  6. object PayloadEncoder
  7. object PayloadError extends Serializable
  8. object PayloadPath extends Serializable
  9. object StringAndBlobCodecs
  10. object Writer

Inherited from AnyRef

Inherited from Any

Ungrouped