Early Preview

This is currently very much a preview. Please feel free to try things out, but don't be upset if anything is not yet working. Feedback is welcome over on our GitHub Dicussions page.

class Newtonsoft.​Json.​JsonWriter

Assembly: Newtonsoft.Json

Inheritance: object → JsonWriter

Implemented Interfaces

Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data.

Properties

public bool
CloseOutput
Gets or sets a value indicating whether the destination should be closed when this writer is closed.
public bool
AutoCompleteOnClose
Gets or sets a value indicating whether the JSON should be auto-completed when this writer is closed.
public WriteState
WriteState
Gets the state of the writer.
public string
Path
Gets the path of the writer.
public Formatting
Formatting
Gets or sets a value indicating how JSON text output should be formatted.
DateFormatHandling
Gets or sets how dates are written to JSON text.
DateTimeZoneHandling
Gets or sets how <see cref="T:System.DateTime" /> time zones are handled when writing JSON text.
StringEscapeHandling
Gets or sets how strings are escaped when writing JSON text.
FloatFormatHandling
Gets or sets how special floating point numbers, e.g. <see cref="F:System.Double.NaN" /> , <see cref="F:System.Double.PositiveInfinity" /> and <see cref="F:System.Double.NegativeInfinity" /> , are written to JSON text.
public string
DateFormatString
Gets or sets how <see cref="T:System.DateTime" /> and <see cref="T:System.DateTimeOffset" /> values are formatted when writing JSON text.
Culture
Gets or sets the culture used when writing JSON. Defaults to <see cref="P:System.Globalization.CultureInfo.InvariantCulture" /> .

Methods

CloseAsync​(System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously closes this writer. If <see cref="P:Newtonsoft.Json.JsonWriter.CloseOutput" /> is set to <c>true</c> , the destination is also closed.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
FlushAsync​(System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteEndAsync​(JsonToken token, System.​Threading.​CancellationToken cancellationToken)
Asynchronously writes the specified end token.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
token The end token to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteIndentAsync​(System.​Threading.​CancellationToken cancellationToken)
Asynchronously writes indent characters.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueDelimiterAsync​(System.​Threading.​CancellationToken cancellationToken)
Asynchronously writes the JSON value delimiter.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteIndentSpaceAsync​(System.​Threading.​CancellationToken cancellationToken)
Asynchronously writes an indent space.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteRawAsync​(string json, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes raw JSON without changing the writer's state.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
json The raw JSON to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteEndAsync​(System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes the end of the current JSON object or array.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteEndArrayAsync​(System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes the end of an array.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteEndConstructorAsync​(System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes the end of a constructor.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteEndObjectAsync​(System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes the end of a JSON object.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteNullAsync​(System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a null value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WritePropertyNameAsync​(string name, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes the property name of a name/value pair of a JSON object.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
name The name of the property.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WritePropertyNameAsync​(string name, bool escape, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes the property name of a name/value pair of a JSON object.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
name The name of the property.
escape A flag to indicate whether the text should be escaped when it is written as a JSON property name.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteStartArrayAsync​(System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes the beginning of a JSON array.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteCommentAsync​(string text, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a comment <c>/*...*/</c> containing the specified text.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
text Text to place inside the comment.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteRawValueAsync​(string json, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes raw JSON where a value is expected and updates the writer's state.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
json The raw JSON to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteStartConstructorAsync​(string name, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes the start of a constructor with the given name.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
name The name of the constructor.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteStartObjectAsync​(System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes the beginning of a JSON object.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteTokenAsync​(JsonReader reader, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes the current <see cref="T:Newtonsoft.Json.JsonReader" /> token.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
reader The <see cref="T:Newtonsoft.Json.JsonReader" /> to read the token from.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteTokenAsync​(JsonReader reader, bool writeChildren, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes the current <see cref="T:Newtonsoft.Json.JsonReader" /> token.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
reader The <see cref="T:Newtonsoft.Json.JsonReader" /> to read the token from.
writeChildren A flag indicating whether the current token's children should be written.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteTokenAsync​(JsonToken token, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes the <see cref="T:Newtonsoft.Json.JsonToken" /> token and its value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
token The <see cref="T:Newtonsoft.Json.JsonToken" /> to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteTokenAsync​(JsonToken token, object value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes the <see cref="T:Newtonsoft.Json.JsonToken" /> token and its value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
token The <see cref="T:Newtonsoft.Json.JsonToken" /> to write.
value The value to write. A value is only required for tokens that have an associated value, e.g. the <see cref="T:System.String" /> property name for <see cref="F:Newtonsoft.Json.JsonToken.PropertyName" /> . <c>null</c> can be passed to the method for tokens that don't have a value, e.g. <see cref="F:Newtonsoft.Json.JsonToken.StartObject" /> .
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(bool value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.Boolean" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.Boolean" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(bool? value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.Boolean" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.Boolean" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(byte value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.Byte" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.Byte" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(byte? value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.Byte" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.Byte" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(byte[] value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.Byte" /> [] value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.Byte" /> [] value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(char value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.Char" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.Char" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(char? value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.Char" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.Char" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(System.​DateTime value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.DateTime" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.DateTime" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(System.​DateTime? value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.DateTime" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.DateTime" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(System.​DateTimeOffset value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.DateTimeOffset" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.DateTimeOffset" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(System.​DateTimeOffset? value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.DateTimeOffset" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.DateTimeOffset" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(decimal value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.Decimal" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.Decimal" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(decimal? value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.Decimal" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.Decimal" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(double value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.Double" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.Double" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(double? value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.Double" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.Double" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(System.​Single value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.Single" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.Single" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(System.​Single? value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.Single" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.Single" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(System.​Guid value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.Guid" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.Guid" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(System.​Guid? value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.Guid" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.Guid" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(int value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.Int32" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.Int32" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(int? value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.Int32" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.Int32" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(long value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.Int64" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.Int64" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(long? value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.Int64" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.Int64" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(object value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.Object" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.Object" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(sbyte value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.SByte" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.SByte" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(sbyte? value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.SByte" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.SByte" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(short value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.Int16" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.Int16" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(short? value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.Int16" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.Int16" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(string value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.String" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.String" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(System.​TimeSpan value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.TimeSpan" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.TimeSpan" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(System.​TimeSpan? value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.TimeSpan" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.TimeSpan" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(uint value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.UInt32" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.UInt32" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(uint? value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.UInt32" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.UInt32" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(ulong value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.UInt64" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.UInt64" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(ulong? value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.UInt64" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.UInt64" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(System.​Uri value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.Uri" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.Uri" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(ushort value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.UInt16" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.UInt16" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteValueAsync​(ushort? value, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.UInt16" /> value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.UInt16" /> value to write.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteUndefinedAsync​(System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes an undefined value.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
WriteWhitespaceAsync​(string ws, System.​Threading.​CancellationToken cancellationToken = null)
Asynchronously writes the given white space.
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
ws The string of white space characters.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
SetWriteStateAsync​(JsonToken token, object value, System.​Threading.​CancellationToken cancellationToken)
Asynchronously ets the state of the <see cref="T:Newtonsoft.Json.JsonWriter" /> .
Returns A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.
token The <see cref="T:Newtonsoft.Json.JsonToken" /> being written.
value The value being written.
cancellationToken The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" /> .
Remarks The default behaviour is to execute synchronously, returning an already-completed task. Derived classes can override this behaviour for true asychronousity.
public void
Flush​()
Flushes whatever is in the buffer to the destination and also flushes the destination.
public void
Close​()
Closes this writer. If <see cref="P:Newtonsoft.Json.JsonWriter.CloseOutput" /> is set to <c>true</c> , the destination is also closed. If <see cref="P:Newtonsoft.Json.JsonWriter.AutoCompleteOnClose" /> is set to <c>true</c> , the JSON is auto-completed.
public void
WriteStartObject​()
Writes the beginning of a JSON object.
public void
WriteEndObject​()
Writes the end of a JSON object.
public void
WriteStartArray​()
Writes the beginning of a JSON array.
public void
WriteEndArray​()
Writes the end of an array.
public void
WriteStartConstructor​(string name)
Writes the start of a constructor with the given name.
name The name of the constructor.
public void
WriteEndConstructor​()
Writes the end constructor.
public void
WritePropertyName​(string name)
Writes the property name of a name/value pair of a JSON object.
name The name of the property.
public void
WritePropertyName​(string name, bool escape)
Writes the property name of a name/value pair of a JSON object.
name The name of the property.
escape A flag to indicate whether the text should be escaped when it is written as a JSON property name.
public void
WriteEnd​()
Writes the end of the current JSON object or array.
public void
WriteToken​(JsonReader reader)
Writes the current <see cref="T:Newtonsoft.Json.JsonReader" /> token and its children.
reader The <see cref="T:Newtonsoft.Json.JsonReader" /> to read the token from.
public void
WriteToken​(JsonReader reader, bool writeChildren)
Writes the current <see cref="T:Newtonsoft.Json.JsonReader" /> token.
reader The <see cref="T:Newtonsoft.Json.JsonReader" /> to read the token from.
writeChildren A flag indicating whether the current token's children should be written.
public void
WriteToken​(JsonToken token, object value)
Writes the <see cref="T:Newtonsoft.Json.JsonToken" /> token and its value.
token The <see cref="T:Newtonsoft.Json.JsonToken" /> to write.
value The value to write. A value is only required for tokens that have an associated value, e.g. the <see cref="T:System.String" /> property name for <see cref="F:Newtonsoft.Json.JsonToken.PropertyName" /> . <c>null</c> can be passed to the method for tokens that don't have a value, e.g. <see cref="F:Newtonsoft.Json.JsonToken.StartObject" /> .
public void
WriteToken​(JsonToken token)
Writes the <see cref="T:Newtonsoft.Json.JsonToken" /> token.
token The <see cref="T:Newtonsoft.Json.JsonToken" /> to write.
protected void
WriteEnd​(JsonToken token)
Writes the specified end token.
token The end token to write.
protected void
WriteIndent​()
Writes indent characters.
protected void
WriteValueDelimiter​()
Writes the JSON value delimiter.
protected void
WriteIndentSpace​()
Writes an indent space.
public void
WriteNull​()
Writes a null value.
public void
WriteUndefined​()
Writes an undefined value.
public void
WriteRaw​(string json)
Writes raw JSON without changing the writer's state.
json The raw JSON to write.
public void
WriteRawValue​(string json)
Writes raw JSON where a value is expected and updates the writer's state.
json The raw JSON to write.
public void
WriteValue​(string value)
Writes a <see cref="T:System.String" /> value.
value The <see cref="T:System.String" /> value to write.
public void
WriteValue​(int value)
Writes a <see cref="T:System.Int32" /> value.
value The <see cref="T:System.Int32" /> value to write.
public void
WriteValue​(uint value)
Writes a <see cref="T:System.UInt32" /> value.
value The <see cref="T:System.UInt32" /> value to write.
public void
WriteValue​(long value)
Writes a <see cref="T:System.Int64" /> value.
value The <see cref="T:System.Int64" /> value to write.
public void
WriteValue​(ulong value)
Writes a <see cref="T:System.UInt64" /> value.
value The <see cref="T:System.UInt64" /> value to write.
public void
WriteValue​(System.​Single value)
Writes a <see cref="T:System.Single" /> value.
value The <see cref="T:System.Single" /> value to write.
public void
WriteValue​(double value)
Writes a <see cref="T:System.Double" /> value.
value The <see cref="T:System.Double" /> value to write.
public void
WriteValue​(bool value)
Writes a <see cref="T:System.Boolean" /> value.
value The <see cref="T:System.Boolean" /> value to write.
public void
WriteValue​(short value)
Writes a <see cref="T:System.Int16" /> value.
value The <see cref="T:System.Int16" /> value to write.
public void
WriteValue​(ushort value)
Writes a <see cref="T:System.UInt16" /> value.
value The <see cref="T:System.UInt16" /> value to write.
public void
WriteValue​(char value)
Writes a <see cref="T:System.Char" /> value.
value The <see cref="T:System.Char" /> value to write.
public void
WriteValue​(byte value)
Writes a <see cref="T:System.Byte" /> value.
value The <see cref="T:System.Byte" /> value to write.
public void
WriteValue​(sbyte value)
Writes a <see cref="T:System.SByte" /> value.
value The <see cref="T:System.SByte" /> value to write.
public void
WriteValue​(decimal value)
Writes a <see cref="T:System.Decimal" /> value.
value The <see cref="T:System.Decimal" /> value to write.
public void
WriteValue​(System.​DateTime value)
Writes a <see cref="T:System.DateTime" /> value.
value The <see cref="T:System.DateTime" /> value to write.
public void
WriteValue​(System.​DateTimeOffset value)
Writes a <see cref="T:System.DateTimeOffset" /> value.
value The <see cref="T:System.DateTimeOffset" /> value to write.
public void
WriteValue​(System.​Guid value)
Writes a <see cref="T:System.Guid" /> value.
value The <see cref="T:System.Guid" /> value to write.
public void
WriteValue​(System.​TimeSpan value)
Writes a <see cref="T:System.TimeSpan" /> value.
value The <see cref="T:System.TimeSpan" /> value to write.
public void
WriteValue​(int? value)
Writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.Int32" /> value.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.Int32" /> value to write.
public void
WriteValue​(uint? value)
Writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.UInt32" /> value.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.UInt32" /> value to write.
public void
WriteValue​(long? value)
Writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.Int64" /> value.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.Int64" /> value to write.
public void
WriteValue​(ulong? value)
Writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.UInt64" /> value.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.UInt64" /> value to write.
public void
WriteValue​(System.​Single? value)
Writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.Single" /> value.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.Single" /> value to write.
public void
WriteValue​(double? value)
Writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.Double" /> value.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.Double" /> value to write.
public void
WriteValue​(bool? value)
Writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.Boolean" /> value.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.Boolean" /> value to write.
public void
WriteValue​(short? value)
Writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.Int16" /> value.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.Int16" /> value to write.
public void
WriteValue​(ushort? value)
Writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.UInt16" /> value.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.UInt16" /> value to write.
public void
WriteValue​(char? value)
Writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.Char" /> value.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.Char" /> value to write.
public void
WriteValue​(byte? value)
Writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.Byte" /> value.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.Byte" /> value to write.
public void
WriteValue​(sbyte? value)
Writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.SByte" /> value.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.SByte" /> value to write.
public void
WriteValue​(decimal? value)
Writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.Decimal" /> value.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.Decimal" /> value to write.
public void
WriteValue​(System.​DateTime? value)
Writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.DateTime" /> value.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.DateTime" /> value to write.
public void
WriteValue​(System.​DateTimeOffset? value)
Writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.DateTimeOffset" /> value.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.DateTimeOffset" /> value to write.
public void
WriteValue​(System.​Guid? value)
Writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.Guid" /> value.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.Guid" /> value to write.
public void
WriteValue​(System.​TimeSpan? value)
Writes a <see cref="T:System.Nullable`1" /> of <see cref="T:System.TimeSpan" /> value.
value The <see cref="T:System.Nullable`1" /> of <see cref="T:System.TimeSpan" /> value to write.
public void
WriteValue​(byte[] value)
Writes a <see cref="T:System.Byte" /> [] value.
value The <see cref="T:System.Byte" /> [] value to write.
public void
WriteValue​(System.​Uri value)
Writes a <see cref="T:System.Uri" /> value.
value The <see cref="T:System.Uri" /> value to write.
public void
WriteValue​(object value)
Writes a <see cref="T:System.Object" /> value. An error will raised if the value cannot be written as a single JSON token.
value The <see cref="T:System.Object" /> value to write.
public void
WriteComment​(string text)
Writes a comment <c>/*...*/</c> containing the specified text.
text Text to place inside the comment.
public void
WriteWhitespace​(string ws)
Writes the given white space.
ws The string of white space characters.
protected void
Dispose​(bool disposing)
Releases unmanaged and - optionally - managed resources.
disposing <c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.
protected void
SetWriteState​(JsonToken token, object value)
Sets the state of the <see cref="T:Newtonsoft.Json.JsonWriter" /> .
token The <see cref="T:Newtonsoft.Json.JsonToken" /> being written.
value The value being written.
public bool
Equals​(object obj)
Inherited from object
protected void
Finalize​()
Inherited from object
public int
GetHashCode​()
Inherited from object
GetType​()
Inherited from object
protected object
MemberwiseClone​()
Inherited from object
public string
ToString​()
Inherited from object