Codec

A type class representing the ability to convert a type to and from an XML representation.

For combinators to create codecs, refer to the companion object.

Contract

Instances of this class must satisfy the following contract: Decoding any value produced via encode must succeed, yielding the original value. The mlType field must contain a string representation of the corresponding type in Isabelle/ML.

For the opposite direction, it is generally expected that a value which cannot be produced via encode should not decode cleanly. This is generally achieved by adding tags to the trees. For example, if the codec for type Foo for a given value would produce an XML document t before tagging, the XML document after tagging would be <tag name="foo">t</tag>. The tagged method transforms a raw codec into a tagged codec. Nested tags are allowed (for example, when chaining multiple calls of tagged), but produce additional overhead in the resulting XML documents.

Self Type: Codec[T]

Linear Supertypes

AnyRef, Any

Known Subclasses

Variant

Abstract Value Members

abstract def decode(tree: Tree): XMLResult[T]

Decode a value from an XML tree, or produce an error.
Decode a value from an XML tree, or produce an error.

See also
XMLResult
abstract def encode(t: T): Tree

Encode a value into an XML tree.
Encode a value into an XML tree.
You may want to use one of the two constructors elem and text.
abstract val mlType: String

String representation of the type corresponding to T in Isabelle/ML.

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 decodeOrThrow(tree: Tree): T
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 list: Codec[List[T]]

Codec for a list of Ts, tagged with the string list.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def ptransform[U](f: (T) ⇒ Option[U], g: (U) ⇒ T, mlType0: String): Codec[U]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def tagged(tag: String): Codec[T]

Create an identical codec which adds (or expects, respectively) an additional top-level tag.
Create an identical codec which adds (or expects, respectively) an additional top-level tag.
The given tag can be anything acceptable as an XML attribute value, but should be globally unique. That is, no other codec should have the same tag. It is fine if there are multiple codecs for a type, as long as their tags are distinct, although that is not a requirement.
def toString(): String

Definition Classes
AnyRef → Any
def transform[U](f: (T) ⇒ U, g: (U) ⇒ T, mlType0: String): Codec[U]

Transform a codec for a type T into a codec for a type U by applying one of the two specified conversions.
Transform a codec for a type T into a codec for a type U by applying one of the two specified conversions.
After creating a new instance using transform, it is recommended to add a new tag.
def tuple[U](that: Codec[U]): Codec[(T, U)]

Codec for a pair of T and U, tagged with the string tuple.
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 Codec | package isabelle

trait Codec[T] extends AnyRef

Abstract Value Members

abstract def decode(tree: Tree): XMLResult[T]

abstract def encode(t: T): Tree

abstract val mlType: String

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 decodeOrThrow(tree: Tree): T

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 list: Codec[List[T]]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def ptransform[U](f: (T) ⇒ Option[U], g: (U) ⇒ T, mlType0: String): Codec[U]

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

def tagged(tag: String): Codec[T]

def toString(): String

def transform[U](f: (T) ⇒ U, g: (U) ⇒ T, mlType0: String): Codec[U]

def tuple[U](that: Codec[U]): Codec[(T, U)]

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