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

StringDecoder

kantan.codecs.strings.StringDecoder
object StringDecoder extends DecoderCompanion[String, DecodeError, codecs.type], PlatformSpecificDecoders

Provides instance creation and summing methods for StringDecoder.

Default StringDecoder instances are provided in codecs.

Attributes

Graph
Supertypes
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type

Members list

Value members

Concrete methods

def makeSafe[D](typeName: String)(f: String => D): String => StringResult[D]

Creates a safe decoding function from the specified unsafe one.

Creates a safe decoding function from the specified unsafe one.

This method expects the specified decoding function to be able to fail by throwing exceptions. These will be caught and wrapped in DecodeError.

This is typically used in conjunction with [StringDecoder.from], when creating instances for types that are not isomorphic to String.

Type parameters

D

decoded type.

Value parameters

f

decoding function.

typeName

name of the decoded type (used in error messages).

Attributes

Example 
scala> val decoder = StringDecoder.makeSafe("Int")(_.toInt)
scala> decoder("1")
res1: StringResult[Int] = Right(1)
scala> decoder("foobar")
res2: StringResult[Int] = Left(DecodeError: 'foobar' is not a valid Int)

Inherited methods

def apply[D](implicit ev: Decoder[String, D, DecodeError, codecs.type]): Decoder[String, D, DecodeError, codecs.type]

Summons an implicit instance of Decoder if one is found, fails compilation otherwise.

Summons an implicit instance of Decoder if one is found, fails compilation otherwise.

This is a slightly faster, less verbose version of implicitly.

Attributes

Inherited from:
DecoderCompanion
def dateDecoder(format: DateFormat): StringDecoder[Date]

Creates a StringDecoder instance for java.util.Date.

Creates a StringDecoder instance for java.util.Date.

Attributes

Inherited from:
PlatformSpecificDecoders
def from[D](f: String => Either[DecodeError, D]): Decoder[String, D, DecodeError, codecs.type]

Creates a new Decoder instance from the specified function.

Creates a new Decoder instance from the specified function.

Attributes

Inherited from:
DecoderCompanion
def fromPartial[D](f: PartialFunction[String, Either[DecodeError, D]])(implicit t: IsError[DecodeError]): Decoder[String, D, DecodeError, codecs.type]

Attributes

Inherited from:
DecoderCompanion
def fromUnsafe[D](f: String => D)(implicit t: IsError[DecodeError]): Decoder[String, D, DecodeError, codecs.type]

Creates a new Decoder instance from the specified function.

Creates a new Decoder instance from the specified function.

This method turns the specified function safe. The error message might end up being a bit generic though - use from if you want to deal with errors explicitly.

Attributes

Inherited from:
DecoderCompanion
def oneOf[D](ds: Decoder[String, D, DecodeError, codecs.type]*)(implicit i: IsError[DecodeError]): Decoder[String, D, DecodeError, codecs.type]

Creates a new Decoder instance from the specified alternatives.

Creates a new Decoder instance from the specified alternatives.

When decoding, each of the specified decoders will be attempted. The result will be the first success if found, or the last failure otherwise.

Attributes

Inherited from:
DecoderCompanion
Generated with