shared-compiler/org.jetbrains.kotlinx.jupyter.streams

Package-level declarations

Types

class BlockingSubstitutionEngine<DataT>(dataFlowComponents: DataFlowComponents<DataT>) : SubstitutionEngine<DataT>

Implements the logic of substitution for StreamSubstitutionType.BLOCKING

class CapturingOutputStream(parentStream: PrintStream?, conf: OutputConfig, captureOutput: Boolean, val onCaptured: (String) -> Unit) : OutputStream

An OutputStream that captures the written content while optionally forwarding it to a parentStream. Capturing only happens if captureOutput is true. The captured content is passed to a callback function onCaptured when certain buffer conditions are met. These conditions are defined by conf.

DataFactory

typealias DataFactory<DataT> = (initialData: DataT?) -> DataT

Creates new data using possibly existing initial data

DataFinalizer

typealias DataFinalizer<DataT> = (newData: DataT, oldData: DataT) -> Unit

Substitutes old data back to the property. Possibly destroys newData as long it's no longer necessary

DataFlowComponents

class DataFlowComponents<DataT>(val initialData: DataT, val substitutor: DataSubstitutor<DataT>, val finalizer: DataFinalizer<DataT>)

Parameters of SubstitutionEngine

DataList

class DataList<DataT>(initialData: DataT)

Represents a list of data items. Supports three operations:

DataSubstitutor

typealias DataSubstitutor<DataT> = (newData: DataT) -> DataT

Substitutes the shared data property with the newData. Returns previous value of the property

DelegatingInputStream

class DelegatingInputStream(val getDelegate: () -> InputStream) : InputStream

DelegatingPrintStream

class DelegatingPrintStream(getDelegate: () -> PrintStream) : PrintStream

DisabledStdinInputStream

object DisabledStdinInputStream : InputStream

KernelStreams

object KernelStreams

NonBlockingSubstitutionEngine

class NonBlockingSubstitutionEngine<DataT : Any>(dataFlowComponents: DataFlowComponents<DataT>) : SubstitutionEngine<DataT>

Implements the logic of substitution for StreamSubstitutionType.NON_BLOCKING

StdinInputStream

class StdinInputStream(communicationFacility: JupyterCommunicationFacility) : InputStream

StreamSubstitutionManager

abstract class StreamSubstitutionManager<StreamT : Closeable>(systemStreamProp: KMutableProperty0<StreamT>, kernelStreamProp: KMutableProperty0<StreamT>?, delegatingStreamFactory: (delegateFactory: () -> StreamT) -> StreamT, substitutionEngineType: StreamSubstitutionType)

An abstract class designed to manage substituting of standard streams with some custom streams.

SubstitutionEngine

abstract class SubstitutionEngine<DataT>(dataFlowComponents: DataFlowComponents<DataT>)

Handles the logic of how data is created, when it's substituted instead of the previous value of a shared resource, and how it's substituted back