airframe-codec
API
Generated with
airframe-codec/wvlet.airframe.codec

wvlet.airframe.codec

package wvlet.airframe.codec

Members list

Type members

Classlikes

trait AnyCodecCompat

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class AnyCodec
trait CodecErrorCode

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object INVALID_DATA
object CollectionCodec

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object Compat

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Compat.type
sealed trait DataType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ANY
trait NamedType
object BINARY
object BOOLEAN
object FLOAT
object INTEGER
object JSON
object NIL
object STRING
object TIMESTAMP
class RecordType
class ARRAY
class MAP
class UNION
Show all
object DataType

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
DataType.type
class EnumCodec[A](enumSurface: EnumSurface) extends MessageCodec[A]

A codec for Enum-like case objects that can be instantiated with unapply(String)

A codec for Enum-like case objects that can be instantiated with unapply(String)

Attributes

Supertypes
trait MessageCodec[A]
trait LogSupport
trait LazyLogger
trait LoggingMethods
trait Serializable
class Object
trait Matchable
class Any
Show all
case class GenericException(exceptionClass: String, message: String, stackTrace: Seq[GenericStackTraceElement], cause: Option[GenericException]) extends Throwable

Generic representation of Throwable for RPC messaging and logging exception

Generic representation of Throwable for RPC messaging and logging exception

Attributes

Companion
object
Supertypes
trait Product
trait Equals
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
object GenericException

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class GenericStackTraceElement(className: String, methodName: String, fileName: Option[String], lineNumber: Int)

Generic stacktrace representation

Generic stacktrace representation

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case object INVALID_DATA extends CodecErrorCode

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
object JSONCodec extends MessageCodec[String]

Codec for JSON String

Codec for JSON String

Attributes

Supertypes
trait MessageCodec[String]
trait LogSupport
trait LazyLogger
trait LoggingMethods
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
JSONCodec.type
object JSONValueCodec extends MessageCodec[JSONValue]

Codec for JSONValue

Codec for JSONValue

Attributes

Supertypes
trait MessageCodec[JSONValue]
trait LogSupport
trait LazyLogger
trait LoggingMethods
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
object JavaInstantTimeCodec extends MessageCodec[Instant]

Attributes

Supertypes
trait MessageCodec[Instant]
trait LogSupport
trait LazyLogger
trait LoggingMethods
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
object JavaUtilDateCodec extends MessageCodec[Date], LogSupport

Attributes

Supertypes
trait MessageCodec[Date]
trait LogSupport
trait LazyLogger
trait LoggingMethods
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
case class LazyCodec[A](surface: Surface, codecFactory: MessageCodecFactory) extends MessageCodec[A]

For generating codec for recursive types.

For generating codec for recursive types.

For example, if type X has a recursion like X(name:String, child:Option[X]), LazyCodec will be used to generate a codec instance as MessageCodec[X](StringCodec, OptionCodec(LazyCodec[X])).

Attributes

Supertypes
trait Product
trait Equals
trait MessageCodec[A]
trait LogSupport
trait LazyLogger
trait LoggingMethods
trait Serializable
class Object
trait Matchable
class Any
Show all
case object MISSING_PARAMETER extends CodecErrorCode

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
trait MessageCodec[A] extends LogSupport

Attributes

Companion
object
Supertypes
trait LogSupport
trait LazyLogger
trait LoggingMethods
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
class IndexedSeqCodec[A]
class JavaListCodec[A]
class ListCodec[A]
class MapCodecBase[A, B, MapType]
class JavaMapCodec[A, B]
class ListMapCodec[A, B]
class MapCodec[A, B]
class SeqCodec[A]
class EnumCodec[A]
object JSONCodec
class LazyCodec[A]
object CountCodec
object DataSizeCodec
class ObjectCodec[A]
class ObjectMapCodec[A]
object AnyArrayCodec
class AnyCodec
object IntArrayCodec
trait PrimitiveCodec[A]
object BigIntCodec
object BooleanCodec
object ByteCodec
object CharCodec
object DoubleCodec
object FloatCodec
object IntCodec
object LongCodec
object ShortCodec
object StringCodec
object UnitCodec
object ValueCodec
object RawJsonCodec
class EitherCodec[A, B]
class OptionCodec[A]
class TupleCodec
object ULIDCodec
object UUIDCodec
class UnionCodec
Show all
object MessageCodec extends MessageCodecBase

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
class MessageCodecException(val errorCode: CodecErrorCode, val codec: MessageCodec[_], val message: String) extends Exception

Attributes

Supertypes
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
case class MessageCodecFactory(codecFinder: MessageCodecFinder, mapOutput: Boolean) extends MessageCodecFactoryBase, LogSupport

Attributes

Companion
object
Supertypes
trait Product
trait Equals
trait LogSupport
trait LazyLogger
trait LoggingMethods
trait Serializable
class Object
trait Matchable
class Any
Show all
object MessageCodecFactory

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
trait MessageCodecFinder

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object empty
object MessageCodecFinder extends LogSupport

Attributes

Companion
trait
Supertypes
trait LogSupport
trait LazyLogger
trait LoggingMethods
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
case class MessageContext()

MessageContext is used for passing the parsing configuration and the last value read by codec.

MessageContext is used for passing the parsing configuration and the last value read by codec.

For efficiency, it holds several primitive type values as local variables to avoid the boxing overhead.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
trait MessageValueCodec[A] extends MessageCodec[A]

Attributes

Supertypes
trait MessageCodec[A]
trait LogSupport
trait LazyLogger
trait LoggingMethods
trait Serializable
class Object
trait Matchable
class Any
Show all
object MetricsCodec

Codecs for airframe-metrics

Codecs for airframe-metrics

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class ObjectCodec[A](surface: Surface, paramCodec: Seq[MessageCodec[_]]) extends MessageCodec[A], ObjectCodecBase, PackAsMapSupport[A], LogSupport

Attributes

Supertypes
trait Product
trait Equals
trait PackAsMapSupport[A]
trait MessageCodec[A]
trait LogSupport
trait LazyLogger
trait LoggingMethods
trait Serializable
class Object
trait Matchable
class Any
Show all
sealed trait ObjectCodecBase

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ObjectCodec[A]
class ObjectMapCodec[A]
case class ObjectMapCodec[A](surface: Surface, paramCodec: Seq[MessageCodec[_]]) extends MessageCodec[A], ObjectCodecBase, PackAsMapSupport[A], LogSupport

ObjectCodec for generating map values. This is suited to JSON object generation

ObjectCodec for generating map values. This is suited to JSON object generation

Attributes

Supertypes
trait Product
trait Equals
trait PackAsMapSupport[A]
trait MessageCodec[A]
trait LogSupport
trait LazyLogger
trait LoggingMethods
trait Serializable
class Object
trait Matchable
class Any
Show all
trait PackAsMapSupport[A]

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ObjectCodec[A]
class ObjectMapCodec[A]
Self type
trait PackSupport

If a class is extending PackSupport, pack(Packer) method will be used for serializing (packing) this object.

If a class is extending PackSupport, pack(Packer) method will be used for serializing (packing) this object.

For deserializing (unpacking) data of type A, define a package method unapply(string:String): Option[A].

In future, we may support unapply(u:Unpacker): Option[A] method

Attributes

Supertypes
class Object
trait Matchable
class Any
class ParamListCodec(name: String, params: IndexedSeq[Parameter], paramCodec: Seq[MessageCodec[_]], methodOwner: Option[Any]) extends MessageCodec[Seq[Any]], LogSupport

A generic codec for parameter lists:

A generic codec for parameter lists:

  • array form: [v1, v2, ...]
  • map form: {k1:v1, k2:v2, ..}

Attributes

Supertypes
trait MessageCodec[Seq[Any]]
trait LogSupport
trait LazyLogger
trait LoggingMethods
trait Serializable
class Object
trait Matchable
class Any
Show all
object PrefixedULIDCodec extends MessageCodec[PrefixedULID]

Attributes

Supertypes
trait MessageCodec[PrefixedULID]
trait LogSupport
trait LazyLogger
trait LoggingMethods
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
object PrimitiveCodec

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object RawJsonCodec extends MessageCodec[Json]

Attributes

Supertypes
trait MessageCodec[Json]
trait LogSupport
trait LazyLogger
trait LoggingMethods
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
object ScalaCompat

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object ScalaStandardCodec

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object StandardCodec

Standard codec collection

Standard codec collection

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object ThrowableCodec extends MessageCodec[Throwable]

Codec for Exception (Throwable) classes

Codec for Exception (Throwable) classes

Attributes

Supertypes
trait MessageCodec[Throwable]
trait LogSupport
trait LazyLogger
trait LoggingMethods
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
object ULIDCodec extends MessageCodec[ULID]

Attributes

Supertypes
trait MessageCodec[ULID]
trait LogSupport
trait LazyLogger
trait LoggingMethods
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
ULIDCodec.type
object UUIDCodec extends MessageCodec[UUID]

Attributes

Supertypes
trait MessageCodec[UUID]
trait LogSupport
trait LazyLogger
trait LoggingMethods
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
UUIDCodec.type
case class UnionCodec(codecs: Map[Surface, MessageCodec[_]]) extends MessageCodec[Union]

Codec for union classes (e.g., A or B) This codec is necessary for defining OpenAPI's model classes

Codec for union classes (e.g., A or B) This codec is necessary for defining OpenAPI's model classes

Attributes

Supertypes
trait Product
trait Equals
trait MessageCodec[Union]
trait LogSupport
trait LazyLogger
trait LoggingMethods
trait Serializable
class Object
trait Matchable
class Any
Show all
Generated with