codecs-core
API
Generated with
codecs-core/kantan.codecs/kantan.codecs.strings

kantan.codecs.strings

package kantan.codecs.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.

Attributes

Members list

Type members

Classlikes

sealed case class DecodeError(message: String) extends Error

Attributes

Companion
object
Supertypes
class Error
trait Product
trait Equals
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
object DecodeError extends ErrorCompanion[DecodeError]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
trait PlatformSpecificCodecs

JVM-specific codecs.

JVM-specific codecs.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object StringCodec
trait PlatformSpecificDecoders

JVM-specific decoders.

JVM-specific decoders.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object StringDecoder
trait PlatformSpecificEncoders

JVM-specific encoders.

JVM-specific encoders.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object StringEncoder
trait PlatformSpecificInstances

JVM-specific codec instances.

JVM-specific codec instances.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object codecs
object StringCodec extends CodecCompanion[String, DecodeError, codecs.type], 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.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object StringDecoder extends DecoderCompanion[String, DecodeError, codecs.type], PlatformSpecificDecoders

Provides instance creation and summing methods for StringDecoder.

Provides instance creation and summing methods for StringDecoder.

Default StringDecoder instances are provided in codecs.

Attributes

Supertypes
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
object StringEncoder extends EncoderCompanion[String, codecs.type], PlatformSpecificEncoders

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object StringResult extends WithError[DecodeError]

Attributes

Supertypes
class Object
trait Matchable
class Any
Show all
Self type
object codecs extends PlatformSpecificInstances

Defines default instances for StringEncoder and StringDecoder.

Defines default instances for StringEncoder and StringDecoder.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
codecs.type

Types

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

Codec for strings.

Codec for strings.

Attributes

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

Decoder for strings.

Decoder for strings.

Default instances can be found in codecs.

Attributes

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

Encoder for strings.

Encoder for strings.

Default instances can be found in codecs.

Attributes

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

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

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

Attributes

Generated with