Class OutputBuffer<T>Abstract

Non-blocking token stream buffer.

Type Parameters

  • T = unknown

Hierarchy

Constructors

constructor

Properties

capacity index limit remaining settings

Methods

asPart bind clone debug display flush get has isCont isDone isError isFull isPart push set step trap withIndex withLimit withSettings write writeln done error full

Constructors

constructor

Properties

Abstract Readonly capacity

capacity: number

Abstract Readonly index

index: number

Abstract Readonly limit

limit: number

Abstract Readonly remaining

remaining: number

Abstract Readonly settings

settings: OutputSettings

The OutputSettings used to configure the behavior of output producers that write to this Output.

Methods

Abstract asPart

  • Returns a partial Output equivalent to this Output, if part is true; returns a final Output equivalent to this Output if part is false. The caller's reference to this Output should be replaced by the returned Output.

    Parameters

    • part: boolean

    Returns OutputBuffer<T>

Abstract bind

  • Returns the implementation-defined result of writing the output.

    Returns T

clone

  • Returns an implementation-defined branch of the token stream.

    Returns OutputBuffer<T>

    Throws

    Error if this Output writer cannot be cloned.

debug

  • Writes the code points of the developer-readable [[Debug]] string of the given object. Assumes this is a Unicode Output writer with sufficient capacity.

    Parameters

    • object: unknown

    Returns Output<T>

    the continuation of the output.

    Throws

    [[OutputException]] if this Output exits the cont state before the full debug string has been written.

display

  • Writes the code points of the human-readable [[Display]] string of the given object. Assumes this is a Unicode Output writer with sufficient capacity.

    Parameters

    • object: unknown

    Returns Output<T>

    the continuation of the output.

    Throws

    [[OutputException]] if this Output exits the cont state before the full display string has been written.

flush

  • Writes any internally buffered state to the underlying output stream.

    Returns OutputBuffer<T>

Abstract get

  • Parameters

    • index: number

    Returns number

Abstract has

  • Parameters

    • index: number

    Returns boolean

Abstract isCont

  • Returns true when the next [[write write(number)]] will succeed. i.e. this Output is in the cont state.

    Returns boolean

Abstract isDone

  • Returns true when no write will ever again succeed. i.e. this Output is in the done state.

    Returns boolean

Abstract isError

  • Returns true when an immediate write will fail due to an error with the token stream. i.e. this Output is in the error state. When true, trap() will return the output error.

    Returns boolean

Abstract isFull

  • Returns true when an immediate write will fail, but writes may succeed at some point in the future, i.e. this Output is in the full state.

    Returns boolean

Abstract isPart

  • Returns true if this is a partial Output that will enter the full state when it is unable to write additional tokens.

    Returns boolean

push

  • Parameters

    • Rest ...tokens: number[]

    Returns void

Abstract set

  • Parameters

    • index: number
    • token: number

    Returns void

Abstract step

  • Parameters

    • Optional offset: number

    Returns OutputBuffer<T>

trap

  • Returns the output error. Only guaranteed to return an error when in the error state.

    Returns Error

    Throws

    OutputException if this Output is not in the error state.

Abstract withIndex

  • Parameters

    • index: number

    Returns OutputBuffer<T>

Abstract withLimit

  • Parameters

    • limit: number

    Returns OutputBuffer<T>

Abstract withSettings

  • Updates the settings associated with this Output.

    Parameters

    Returns Output<T>

    this

Abstract write

  • Writes a single token to the stream, if this Output is in the cont state.

    Parameters

    • token: number

    Returns OutputBuffer<T>

    this

    Throws

    [[OutputException]] if this Output is not in the cont state.

  • Writes the code points of the given string. Assumes this is a Unicode Output writer with sufficient capacity.

    Parameters

    • string: string

    Returns OutputBuffer<T>

    this

    Throws

    [[OutputException]] if this Output exits the cont state before the full string has been written.

writeln

  • Writes the code points of the given string, followed by the code points of the settings' [[OutputSettings.lineSeparator line separator]. Assumes this is a Unicode Output writer with sufficient capacity.

    Parameters

    • Optional string: string

    Returns OutputBuffer<T>

    this

    Throws

    [[OutputException]] if this Output exits the cont state before the full string and line separator has been written.

Static done

  • Returns an OutputBuffer in the done state.

    Returns OutputBuffer<never>

Static error

  • Returns an OutputBuffer in the error state that traps the given error.

    Parameters

    • error: Error

    Returns OutputBuffer<never>

Static full

  • Returns an OutputBuffer in the full state.

    Returns OutputBuffer<never>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc