IOPlugin

Companion

common

object Companion : PluginFactory<IOPlugin>

attach

common

open override fun attach(context: Context)

content

common

open override fun content(target: String): Map<Name, Any>

dependsOn

common

override fun dependsOn(): Map<PluginFactory<*>, Meta>

detach

common

open override fun detach()

resolveEnvelopeFormat

common

fun resolveEnvelopeFormat(item: Meta): EnvelopeFormat?

resolveIOFormat

common

fun <T : Any> resolveIOFormat(item: Meta, type: KClass<out T>): IOFormat<T>?

resolveMetaFormat

common

fun resolveMetaFormat(key: Short, meta: Meta = Meta.EMPTY): MetaFormat?

fun resolveMetaFormat(name: String, meta: Meta = Meta.EMPTY): MetaFormat?

toMeta

common

open override fun toMeta(): Meta

context

common

open override val context: Context

defaultChainTarget

common

open val defaultChainTarget: String

defaultTarget

common

open val defaultTarget: String

envelopeFormatFactories

common

val envelopeFormatFactories: Collection<EnvelopeFormatFactory>

ioFormatFactories

common

val ioFormatFactories: Collection<IOFormatFactory<*>>

meta

common

open override val meta: Meta

metaFormatFactories

common

val metaFormatFactories: Collection<MetaFormatFactory>

name

common

open override val name: Name

tag

common

open override val tag: PluginTag

peekFileEnvelopeFormat

jvm

fun IOPlugin.peekFileEnvelopeFormat(path: Path): EnvelopeFormat?

Return inferred EnvelopeFormat if only one format could read given file. If no format accepts file, return null. If multiple formats accepts file, throw an error.

readEnvelopeFile

jvm

fun IOPlugin.readEnvelopeFile(path: Path, readNonEnvelopes: Boolean = false, formatPicker: IOPlugin.(Path) -> EnvelopeFormat? = IOPlugin::peekFileEnvelopeFormat): Envelope

Read and envelope from file if the file exists, return null if file does not exist.

readMetaFile

jvm

fun IOPlugin.readMetaFile(path: Path, formatOverride: MetaFormat? = null, descriptor: MetaDescriptor? = null): Meta

Read file containing meta using given formatOverride or file extension to infer meta type. If path is a directory search for file starting with meta in it

resolveIOFormat

jvm

inline fun <T : Any> IOPlugin.resolveIOFormat(): IOFormat<T>?

Resolve IOFormat based on type

writeEnvelopeDirectory

jvm

fun IOPlugin.writeEnvelopeDirectory(path: Path, envelope: Envelope, metaFormat: MetaFormatFactory = JsonMetaFormat)

Write separate meta and data files to given directory path

writeEnvelopeFile

jvm

fun IOPlugin.writeEnvelopeFile(path: Path, envelope: Envelope, envelopeFormat: EnvelopeFormat = TaggedEnvelopeFormat, metaFormat: MetaFormatFactory? = null)

Write envelope file to given path using envelopeFormat and optional metaFormat

writeMetaFile

jvm

fun IOPlugin.writeMetaFile(path: Path, meta: Meta, metaFormat: MetaFormatFactory = JsonMetaFormat, descriptor: MetaDescriptor? = null)

Write meta to file using metaFormat. If path is a directory, write a file with name equals name of metaFormat. Like "meta.json"

IOPlugin

Types

Functions

Properties

Extensions