sealed abstract class RichTextCodec[A] extends AnyRef

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.

Self Type
RichTextCodec[A]
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RichTextCodec
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. 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.

  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. 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. The label will be used but not explained

  6. final def ??(label: String): Tagged[A]

    Tags the codec with a label used in the documentation

  7. final def as[B](b: ⇒ B)(implicit ev: =:=[A, Unit]): RichTextCodec[B]

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

  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. final def asType[B](implicit ev: =:=[A, B]): RichTextCodec[B]
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  11. final def collectOrFail(failure: String)(pf: PartialFunction[A, A]): RichTextCodec[A]
  12. 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.

  13. final def decode(value: CharSequence): Either[String, A]
  14. final def describe: Doc

    Constructs documentation for this rich text codec.

  15. 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.

  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def merge[B](implicit ev: <:<[A, Either[B, B]]): RichTextCodec[B]

    This method is Right biased merge

  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  25. final def optional(default: A): RichTextCodec[Option[A]]
  26. final lazy val repeat: RichTextCodec[Chunk[A]]
  27. final def singleton: RichTextCodec[NonEmptyChunk[A]]
  28. final def string(implicit ev: =:=[A, Chunk[Char]]): RichTextCodec[String]
  29. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  30. final def tagged(label: String): Tagged[A]
  31. final def taggedUnexplained(label: String): Tagged[A]
  32. def toString(): String
    Definition Classes
    AnyRef → Any
  33. final def transform[B](f: (A) ⇒ B)(g: (B) ⇒ A): RichTextCodec[B]
  34. final def transformOrFail[B](f: (A) ⇒ Either[String, B])(g: (B) ⇒ Either[String, A]): RichTextCodec[B]
  35. final def transformOrFailLeft[B](f: (A) ⇒ Either[String, B])(g: (B) ⇒ A): RichTextCodec[B]
  36. final def transformOrFailRight[B](f: (A) ⇒ B)(g: (B) ⇒ Either[String, A]): RichTextCodec[B]
  37. final def validate(failure: String)(p: (A) ⇒ Boolean): RichTextCodec[A]

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

  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def withError(errorMessage: String): RichTextCodec[A]
  42. final def |[B](that: ⇒ RichTextCodec[B]): RichTextCodec[Either[A, B]]

    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.

  43. final def ~[B](that: ⇒ RichTextCodec[B])(implicit combiner: Combiner[A, B]): RichTextCodec[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.

  44. 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.

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped