CodecForOptional

A codec which can encode to optional raw values / decode from optional raw values. An optional raw value specifies if the raw value should be included in the output, or not. Depending on the codec, decoding from an optional value might yield DecodeResult.Missing.

Should be used for inputs/outputs which allow optional values.

Self Type: CodecForOptional[T, M, R]
Annotations: @implicitNotFound( ... )

Linear Supertypes

Decode[Option[R], T], AnyRef, Any

Abstract Value Members

abstract def decode(s: Option[R]): DecodeResult[T]

Definition Classes
CodecForOptional → Decode
abstract def encode(t: T): Option[R]
abstract def meta: CodecMeta[M, R]

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def map[TT](f: (T) ⇒ TT)(g: (TT) ⇒ T): CodecForOptional[TT, M, R]
def mapDecode[TT](f: (T) ⇒ DecodeResult[TT])(g: (TT) ⇒ T): CodecForOptional[TT, M, R]
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def safeDecode(f: Option[R]): DecodeResult[T]

Calls decode and catches any exceptions that might occur, converting them to decode failures.
Calls decode and catches any exceptions that might occur, converting them to decode failures.

Definition Classes
Decode
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object CodecForOptional | package tapir

trait CodecForOptional[T, M <: MediaType, R] extends Decode[Option[R], T]

Abstract Value Members

abstract def decode(s: Option[R]): DecodeResult[T]

abstract def encode(t: T): Option[R]

abstract def meta: CodecMeta[M, R]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def map[TT](f: (T) ⇒ TT)(g: (TT) ⇒ T): CodecForOptional[TT, M, R]

def mapDecode[TT](f: (T) ⇒ DecodeResult[TT])(g: (TT) ⇒ T): CodecForOptional[TT, M, R]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def safeDecode(f: Option[R]): DecodeResult[T]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Decode[Option[R], T]

Inherited from AnyRef

Inherited from Any

Ungrouped