Gutenberg

Class ConsoleDocumentRenderer

An IDocumentRenderer<T> which writes formatted text to the Console.

Inheritance
  • Object
  • ConsoleDocumentRenderer
Implements
Declaration
public class ConsoleDocumentRenderer : Object, IDocumentRenderer<ConsoleFormattingAnnotation>

Constructors

ConsoleDocumentRenderer()

Declaration
public ConsoleDocumentRenderer()

Methods

NewLine(CancellationToken)

Write a line break into the output stream.

Declaration
public ValueTask NewLine(CancellationToken cancellationToken = null)
Parameters
Type Name Description

CancellationToken

cancellationToken

A CancellationToken.

Returns
Type Description

ValueTask

A ValueTask which will complete when the line break has been written to the output stream.

PopAnnotation(CancellationToken)

Discard the value of a previous call to PushAnnotation(T, CancellationToken).

Declaration
public ValueTask PopAnnotation(CancellationToken cancellationToken = null)
Parameters
Type Name Description

CancellationToken

cancellationToken

A CancellationToken.

Returns
Type Description

ValueTask

A ValueTask which will complete when the value has been popped from the stack.

PushAnnotation(ConsoleFormattingAnnotation, CancellationToken)

Accept an annotation.

Declaration
public ValueTask PushAnnotation(ConsoleFormattingAnnotation value, CancellationToken cancellationToken = null)
Parameters
Type Name Description

ConsoleFormattingAnnotation

value

CancellationToken

cancellationToken

A CancellationToken.

Returns
Type Description

ValueTask

A ValueTask which will complete when the value has been pushed onto the stack.

Text(ReadOnlyMemory<Char>, CancellationToken)

Write some text into the output stream.

Declaration
public ValueTask Text(ReadOnlyMemory<char> memory, CancellationToken cancellationToken = null)
Parameters
Type Name Description

ReadOnlyMemory<Char>

memory

The text to write to the output stream.

CancellationToken

cancellationToken

A CancellationToken.

Returns
Type Description

ValueTask

A ValueTask which will complete when the text has been written to the output stream.

WhiteSpace(Int32, CancellationToken)

Write the given amount of blank space into the output stream.

Declaration
public ValueTask WhiteSpace(int amount, CancellationToken cancellationToken = null)
Parameters
Type Name Description

Int32

amount

The amount of white space to write.

CancellationToken

cancellationToken

A CancellationToken.

Returns
Type Description

ValueTask

A ValueTask which will complete when the white space has been written to the output stream.

Implements

IDocumentRenderer<T>