RichTextCodec

zio.http.codec.RichTextCodec
See theRichTextCodec companion object
sealed abstract class RichTextCodec[A]

A RichTextCodec is a more compositional version of TextCodec, which has similar power to traditional parser combinators / pretty printers. Although slower than the simpler text codecs, they can be utilized to parse structured information in HTTP headers, which in turn allows generating much better error messages and documentation than otherwise possible.

Attributes

Companion
object
Source
RichTextCodec.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Value members

Concrete methods

final def <~(that: => RichTextCodec[Unit]): RichTextCodec[A]

Returns a new codec that is the sequential composition of this codec and the specified codec, but which only produces the value of this codec.

Returns a new codec that is the sequential composition of this codec and the specified codec, but which only produces the value of this codec.

Attributes

Source
RichTextCodec.scala
final def ?!(label: String): Tagged[A]

Tags the codec with a label used in the documentation. The label will be used but not explained

Tags the codec with a label used in the documentation. The label will be used but not explained

Attributes

Source
RichTextCodec.scala
final def ??(label: String): Tagged[A]

Tags the codec with a label used in the documentation

Tags the codec with a label used in the documentation

Attributes

Source
RichTextCodec.scala
final def as[B](b: => B)(implicit ev: A =:= Unit): RichTextCodec[B]

Tranforms this constant unit codec to a constant codec of another type.

Tranforms this constant unit codec to a constant codec of another type.

Attributes

Source
RichTextCodec.scala
final def asType[B](implicit ev: A =:= B): RichTextCodec[B]

Attributes

Source
RichTextCodec.scala
final def collectOrFail(failure: String)(pf: PartialFunction[A, A]): RichTextCodec[A]

Attributes

Source
RichTextCodec.scala
final def const(canonical: A): RichTextCodec[Unit]

Converts this codec of A into a codec of Unit by specifying a canonical value to use when an HTTP client needs to generate a value for this codec.

Converts this codec of A into a codec of Unit by specifying a canonical value to use when an HTTP client needs to generate a value for this codec.

Attributes

Source
RichTextCodec.scala
final def decode(value: CharSequence): Either[String, A]

Attributes

Source
RichTextCodec.scala
final def describe: Doc

Constructs documentation for this rich text codec.

Constructs documentation for this rich text codec.

Attributes

Source
RichTextCodec.scala
final def encode(value: A): Either[String, String]

Encodes a value into a string, or if this is not possible, fails with an error message.

Encodes a value into a string, or if this is not possible, fails with an error message.

Attributes

Source
RichTextCodec.scala
final def merge[B](implicit ev: A <:< Either[B, B]): RichTextCodec[B]

This method is Right biased merge

This method is Right biased merge

Attributes

Source
RichTextCodec.scala
final def optional(default: A): RichTextCodec[Option[A]]

Attributes

Source
RichTextCodec.scala
final def singleton: RichTextCodec[NonEmptyChunk[A]]

Attributes

Source
RichTextCodec.scala
final def string(implicit ev: A =:= Chunk[Char]): RichTextCodec[String]

Attributes

Source
RichTextCodec.scala
final def tagged(label: String): Tagged[A]

Attributes

Source
RichTextCodec.scala
final def taggedUnexplained(label: String): Tagged[A]

Attributes

Source
RichTextCodec.scala
final def transform[B](f: A => B)(g: B => A): RichTextCodec[B]

Attributes

Source
RichTextCodec.scala
final def transformOrFail[B](f: A => Either[String, B])(g: B => Either[String, A]): RichTextCodec[B]

Attributes

Source
RichTextCodec.scala
final def transformOrFailLeft[B](f: A => Either[String, B])(g: B => A): RichTextCodec[B]

Attributes

Source
RichTextCodec.scala
final def transformOrFailRight[B](f: A => B)(g: B => Either[String, A]): RichTextCodec[B]

Attributes

Source
RichTextCodec.scala
final def validate(failure: String)(p: A => Boolean): RichTextCodec[A]

Attempts to validate a decoded value, or fails using the specified failure message.

Attempts to validate a decoded value, or fails using the specified failure message.

Attributes

Source
RichTextCodec.scala
final def withError(errorMessage: String): RichTextCodec[A]

Attributes

Source
RichTextCodec.scala
final def |[B](that: => RichTextCodec[B])(implicit alternator: Alternator[A, B]): RichTextCodec[alternator.Out]

Returns a new codec that is the fallback composition of this codec and the specified codec, preferring this codec, but falling back to the specified codec in the event of failure.

Returns a new codec that is the fallback composition of this codec and the specified codec, preferring this codec, but falling back to the specified codec in the event of failure.

When both codecs have the same output type, the result type is unified (no Either wrapper). When types differ, the result is Either[A, B].

Attributes

Source
RichTextCodec.scala
final def ~[B](that: => RichTextCodec[B])(implicit combiner: Combiner[A, B]): RichTextCodec[combiner.Out]

Returns a new codec that is the sequential composition of this codec and the specified codec, producing the values of both as a tuple.

Returns a new codec that is the sequential composition of this codec and the specified codec, producing the values of both as a tuple.

Attributes

Source
RichTextCodec.scala
final def ~>[B](that: => RichTextCodec[B])(implicit ev: A =:= Unit): RichTextCodec[B]

Returns a new codec that is the sequential composition of this codec and the specified codec, but which only produces the value of that codec.

Returns a new codec that is the sequential composition of this codec and the specified codec, but which only produces the value of that codec.

Attributes

Source
RichTextCodec.scala
final def ~|~(that: => RichTextCodec[Unit])(implicit ev: A =:= Unit): RichTextCodec[Unit]

Attributes

Source
RichTextCodec.scala

Concrete fields

final lazy val repeat: RichTextCodec[Chunk[A]]

Attributes

Source
RichTextCodec.scala
final lazy val repeatNonEmpty: RichTextCodec[NonEmptyChunk[A]]

Attributes

Source
RichTextCodec.scala