Packages

package strings

Defines codecs for encoding to and decoding from strings.

These codecs are not necessary meant to use directly, but more as part of larger ones. kantan.csv, for example, works with CSV files but delegates the act of encoding to or decoding from a CSV cell to string codecs.

Default instances can be found in kantan.codecs.strings.codecs.

Source
package.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. strings
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Package Members

  1. package java8

Type Members

  1. sealed case class DecodeError(message: String) extends Error with Product with Serializable
  2. trait PlatformSpecificCodecs extends AnyRef

    JVM-specific codecs.

  3. trait PlatformSpecificDecoders extends AnyRef

    JVM-specific decoders.

  4. trait PlatformSpecificEncoders extends AnyRef

    JVM-specific encoders.

  5. trait PlatformSpecificInstances extends AnyRef

    JVM-specific codec instances.

  6. type StringCodec[A] = Codec[String, A, DecodeError, codecs.type]

    Codec for strings.

  7. type StringDecoder[A] = Decoder[String, A, DecodeError, codecs.type]

    Decoder for strings.

    Decoder for strings.

    Default instances can be found in codecs.

  8. type StringEncoder[A] = Encoder[String, A, codecs.type]

    Encoder for strings.

    Encoder for strings.

    Default instances can be found in codecs.

  9. type StringResult[A] = Either[DecodeError, A]

    Type of values values returned when attempting to decode a String.

Value Members

  1. object DecodeError extends ErrorCompanion[DecodeError]
  2. object StringCodec extends CodecCompanion[String, DecodeError, codecs.type] with PlatformSpecificCodecs

    Provides instance creation methods.

    Provides instance creation methods.

    No instance summoning method is provided - this is by design. Developers should never work with codecs, but with instances of StringEncoder and StringDecoder instead. Codecs are merely meant as a declaration convenience.

    Default instances are defined in codecs.

  3. object StringDecoder extends DecoderCompanion[String, DecodeError, codecs.type] with PlatformSpecificDecoders

    Provides instance creation and summing methods for StringDecoder.

    Provides instance creation and summing methods for StringDecoder.

    Default StringDecoder instances are provided in codecs.

  4. object StringEncoder extends EncoderCompanion[String, codecs.type] with PlatformSpecificEncoders
  5. object StringResult extends WithError[DecodeError]
  6. object codecs extends PlatformSpecificInstances

    Defines default instances for StringEncoder and StringDecoder.

Inherited from AnyRef

Inherited from Any

Ungrouped