Codec

Type Members

abstract class Variant[A] extends Codec[A]

Template for a codec for a sum type A.
Template for a codec for a sum type A.
Each constructor of A should get assigned a unique index when implementing this class. It is used to tag XML trees, so that the correct decoding function can be chosen.
In addition to the contract of Codec, instances of this class must also preserve the index, that is, any index returned by enc must produce a valid decoding function in dec.
Using this is simple: Instead of creating a new Codec object, create an object extending from this class and implement enc and dec accordingly. It is automatically a Codec.
Example usage
```
new Variant[Option[A]]("option") {
  def enc(a: Option[A]) = a match {
    case Some(a) => (0, Codec[A].encode(a))
    case None    => (1, Codec[Unit].encode(()))
  }
  def dec(idx: Int) = idx match {
    case 0 => Some(Codec[A].decode(_).right.map(Some.apply))
    case 1 => Some(Codec[Unit].decode(_).right.map(_ => None))
    case _ => None
  }
}
```

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
def apply[A](implicit A: Codec[A]): Codec[A]

Obtain an instance of a codec from the implicit scope.
Obtain an instance of a codec from the implicit scope.
Example usage
```
Codec[Int].encode(env)(3)
```
final def asInstanceOf[T0]: T0

Definition Classes
Any
implicit def boolean: Codec[Boolean]
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
implicit def either[A, B](implicit arg0: Codec[A], arg1: Codec[B]): Codec[Either[A, B]]
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
implicit def integer: Codec[BigInt]
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
implicit def list[A](implicit arg0: Codec[A]): Codec[List[A]]
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
implicit def option[A](implicit arg0: Codec[A]): Codec[Option[A]]
implicit def string: Codec[String]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
implicit def tree: Codec[Tree]
implicit def triple[A, B, C](implicit arg0: Codec[A], arg1: Codec[B], arg2: Codec[C]): Codec[(A, B, C)]
implicit def tuple[A, B](implicit arg0: Codec[A], arg1: Codec[B]): Codec[(A, B)]
implicit def unit: Codec[Unit]
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: trait Codec | package isabelle

object Codec

Type Members

abstract class Variant[A] extends Codec[A]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def apply[A](implicit A: Codec[A]): Codec[A]

final def asInstanceOf[T0]: T0

implicit def boolean: Codec[Boolean]

def clone(): AnyRef

implicit def either[A, B](implicit arg0: Codec[A], arg1: Codec[B]): Codec[Either[A, B]]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

implicit def integer: Codec[BigInt]

final def isInstanceOf[T0]: Boolean

implicit def list[A](implicit arg0: Codec[A]): Codec[List[A]]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

implicit def option[A](implicit arg0: Codec[A]): Codec[Option[A]]

implicit def string: Codec[String]

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

def toString(): String

implicit def tree: Codec[Tree]

implicit def triple[A, B, C](implicit arg0: Codec[A], arg1: Codec[B], arg2: Codec[C]): Codec[(A, B, C)]

implicit def tuple[A, B](implicit arg0: Codec[A], arg1: Codec[B]): Codec[(A, B)]

implicit def unit: Codec[Unit]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped