Interface IDocumentRenderer<T>
An interface for objects which know how to render a Document<T>.
Declaration
public interface IDocumentRenderer<in T>Type Parameters
| Name | Description |
|---|---|
T |
The type of annotations in the document. |
Methods
NewLine(CancellationToken)
Write a line break into the output stream.
Declaration
ValueTask NewLine(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
cancellationToken |
Returns
| Type | Description |
|---|---|
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
ValueTask PopAnnotation(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
cancellationToken |
Returns
| Type | Description |
|---|---|
A ValueTask which will complete when the value has been popped from the stack. |
PushAnnotation(T, CancellationToken)
Accept an annotation.
Declaration
ValueTask PushAnnotation(T value, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
T |
value |
The annotation to push onto the stack. |
cancellationToken |
Returns
| Type | Description |
|---|---|
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
ValueTask Text(ReadOnlyMemory<char> memory, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
memory |
The text to write to the output stream. |
|
cancellationToken |
Returns
| Type | Description |
|---|---|
A ValueTask which will complete when the text has been written to the output stream. |
WhiteSpace(int, CancellationToken)
Write the given amount of
blank space into the output stream.
Declaration
ValueTask WhiteSpace(int amount, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
amount |
The amount of white space to write. |
|
cancellationToken |
Returns
| Type | Description |
|---|---|
A ValueTask which will complete when the white space has been written to the output stream. |