EnvelopeFormatFactory

@Type(id = "io.format.envelope")
interface EnvelopeFormatFactory : IOFormatFactory<Envelope> , EnvelopeFormat

Types

Companion
Link copied to clipboard
common
object Companion

Functions

invoke
Link copied to clipboard
common
abstract operator override fun invoke(meta: Meta, context: Context): EnvelopeFormat
peekFormat
Link copied to clipboard
common
abstract fun peekFormat(io: IOPlugin, binary: Binary): EnvelopeFormat?

Try to infer specific format from input and return null if the attempt is failed. This method does not return Input into initial state.

readObject
Link copied to clipboard
common
abstract override fun readObject(input: Input): Envelope
readPartial
Link copied to clipboard
common
abstract fun readPartial(input: Input): PartialEnvelope
toMeta
Link copied to clipboard
common
open override fun toMeta(): Meta
writeEnvelope
Link copied to clipboard
common
abstract fun writeEnvelope(output: Output, envelope: Envelope, metaFormatFactory: MetaFormatFactory = defaultMetaFormat, formatMeta: Meta = Meta.EMPTY)
writeObject
Link copied to clipboard
common
open override fun writeObject(output: Output, obj: Envelope)

Properties

defaultMetaFormat
Link copied to clipboard
common
open val defaultMetaFormat: MetaFormatFactory
name
Link copied to clipboard
common
open override val name: Name
type
Link copied to clipboard
common
open override val type: KType

Explicit type for dynamic type checks

Inheritors

TaggedEnvelopeFormat
Link copied to clipboard
TaglessEnvelopeFormat
Link copied to clipboard