Provides functionality for writing data in a streaming manner to a buffer or a stream. More...

Inheritance diagram for Fauna.Serialization.Utf8FaunaWriter:

Public Member Functions
	Utf8FaunaWriter (IBufferWriter< byte > bufferWriter)
	Initializes a new instance of the Utf8FaunaWriter class with a specified buffer writer.

	Utf8FaunaWriter (Stream stream)
	Initializes a new instance of the Utf8FaunaWriter class with a specified stream.

void	Flush ()
	Flushes the written data to the underlying buffer or stream.

async ValueTask	FlushAsync ()
	Asynchronously flushes the written data to the underlying buffer or stream.

void	Dispose ()
	Disposes the underlying writer.

async ValueTask	DisposeAsync ()
	Asynchronously disposes the underlying writer.

void	WriteStartObject ()
	Writes the beginning of an object.

void	WriteEndObject ()
	Writes the end of an object.

void	WriteStartEscapedObject ()
	Writes the beginning of a specially tagged object.

void	WriteEndEscapedObject ()
	Writes the end of a specially tagged object.

void	WriteStartArray ()
	Writes the beginning of an array.

void	WriteEndArray ()
	Writes the end of an array.

void	WriteStartRef ()
	Writes the beginning of a reference object.

void	WriteEndRef ()
	Writes the end of a reference object.

void	WriteDouble (string fieldName, decimal value)
	Writes a double value with a specific field name.

void	WriteDouble (string fieldName, double value)
	Writes a double value with a specific field name.

void	WriteInt (string fieldName, int value)
	Writes an integer value with a specific field name.

void	WriteLong (string fieldName, long value)
	Writes a long integer value with a specific field name.

void	WriteString (string fieldName, string value)
	Writes a string value with a specific field name.

void	WriteDate (string fieldName, DateTime value)
	Writes a date value with a specific field name.

void	WriteTime (string fieldName, DateTime value)
	Writes a time value with a specific field name.

void	WriteBoolean (string fieldName, bool value)
	Writes a boolean value with a specific field name.

void	WriteNull (string fieldName)
	Writes a null value with a specific field name.

void	WriteModule (string fieldName, Module value)
	Writes a module value with a specific field name.

void	WriteFieldName (string value)
	Writes a field name for the next value.

void	WriteTaggedValue (string tag, string value)
	Writes a tagged value in an object.

void	WriteDoubleValue (decimal value)
	Writes a double value as a tagged element.

void	WriteDoubleValue (double value)
	Writes a double value as a tagged element.

void	WriteIntValue (int value)
	Writes an integer value as a tagged element.

void	WriteLongValue (long value)
	Writes a long integer value as a tagged element.

void	WriteStringValue (string value)
	Writes a string value as a tagged element.

void	WriteDateValue (DateTime value)
	Writes a date value as a tagged element.

void	WriteDateValue (DateOnly value)
	Writes a date value as a tagged element.

void	WriteDateValue (DateTimeOffset value)
	Writes a date value as a tagged element.

void	WriteTimeValue (DateTime value)
	Writes a date value as a tagged element.

void	WriteTimeValue (DateTimeOffset value)
	Writes a date value as a tagged element.

void	WriteBooleanValue (bool value)
	Writes a boolean value to the stream.

void	WriteNullValue ()
	Writes a null value to the stream.

void	WriteModuleValue (Module value)
	Writes a module value as a tagged element.

Detailed Description

Provides functionality for writing data in a streaming manner to a buffer or a stream.

Definition at line 11 of file Utf8FaunaWriter.cs.

Constructor & Destructor Documentation

◆ Utf8FaunaWriter() [1/2]

Fauna.Serialization.Utf8FaunaWriter.Utf8FaunaWriter ( IBufferWriter< byte > bufferWriter )

Initializes a new instance of the Utf8FaunaWriter class with a specified buffer writer.

Parameters

bufferWriter The buffer writer to write to.

Definition at line 19 of file Utf8FaunaWriter.cs.

◆ Utf8FaunaWriter() [2/2]

Fauna.Serialization.Utf8FaunaWriter.Utf8FaunaWriter ( Stream stream )

Initializes a new instance of the Utf8FaunaWriter class with a specified stream.

Parameters

stream The stream to write to.

Definition at line 28 of file Utf8FaunaWriter.cs.

Member Function Documentation

◆ Dispose()

void Fauna.Serialization.Utf8FaunaWriter.Dispose ( )

Disposes the underlying writer.

Definition at line 52 of file Utf8FaunaWriter.cs.

◆ DisposeAsync()

async ValueTask Fauna.Serialization.Utf8FaunaWriter.DisposeAsync ( )

Asynchronously disposes the underlying writer.

Definition at line 60 of file Utf8FaunaWriter.cs.

◆ Flush()

void Fauna.Serialization.Utf8FaunaWriter.Flush ( )

Flushes the written data to the underlying buffer or stream.

Definition at line 36 of file Utf8FaunaWriter.cs.

◆ FlushAsync()

async ValueTask Fauna.Serialization.Utf8FaunaWriter.FlushAsync ( )

Asynchronously flushes the written data to the underlying buffer or stream.

Definition at line 44 of file Utf8FaunaWriter.cs.

◆ WriteBoolean()

void Fauna.Serialization.Utf8FaunaWriter.WriteBoolean	(	string	fieldName,
		bool	value
	)

Writes a boolean value with a specific field name.

Parameters

fieldName	The name of the field.
value	The boolean value to write.

Definition at line 217 of file Utf8FaunaWriter.cs.

◆ WriteBooleanValue()

void Fauna.Serialization.Utf8FaunaWriter.WriteBooleanValue ( bool value )

Writes a boolean value to the stream.

Parameters

value The boolean value to write.

Definition at line 365 of file Utf8FaunaWriter.cs.

◆ WriteDate()

void Fauna.Serialization.Utf8FaunaWriter.WriteDate	(	string	fieldName,
		DateTime	value
	)

Writes a date value with a specific field name.

Parameters

fieldName	The name of the field.
value	The DateTime value to write.

Definition at line 195 of file Utf8FaunaWriter.cs.

◆ WriteDateValue() [1/3]

void Fauna.Serialization.Utf8FaunaWriter.WriteDateValue ( DateOnly value )

Writes a date value as a tagged element.

Parameters

value The date value to write.

Definition at line 325 of file Utf8FaunaWriter.cs.

◆ WriteDateValue() [2/3]

void Fauna.Serialization.Utf8FaunaWriter.WriteDateValue ( DateTime value )

Writes a date value as a tagged element.

Parameters

value The date value to write.

Definition at line 315 of file Utf8FaunaWriter.cs.

◆ WriteDateValue() [3/3]

void Fauna.Serialization.Utf8FaunaWriter.WriteDateValue ( DateTimeOffset value )

Writes a date value as a tagged element.

Parameters

value The date value to write.

Definition at line 335 of file Utf8FaunaWriter.cs.

◆ WriteDouble() [1/2]

void Fauna.Serialization.Utf8FaunaWriter.WriteDouble	(	string	fieldName,
		decimal	value
	)

Writes a double value with a specific field name.

Parameters

fieldName	The name of the field.
value	The decimal value to write.

Definition at line 140 of file Utf8FaunaWriter.cs.

◆ WriteDouble() [2/2]

void Fauna.Serialization.Utf8FaunaWriter.WriteDouble	(	string	fieldName,
		double	value
	)

Writes a double value with a specific field name.

Parameters

fieldName	The name of the field.
value	The double value to write.

Definition at line 151 of file Utf8FaunaWriter.cs.

◆ WriteDoubleValue() [1/2]

void Fauna.Serialization.Utf8FaunaWriter.WriteDoubleValue ( decimal value )

Writes a double value as a tagged element.

Parameters

value The double value to write.

Definition at line 270 of file Utf8FaunaWriter.cs.

◆ WriteDoubleValue() [2/2]

void Fauna.Serialization.Utf8FaunaWriter.WriteDoubleValue ( double value )

Writes a double value as a tagged element.

Parameters

value The double value to write.

Definition at line 279 of file Utf8FaunaWriter.cs.

◆ WriteEndArray()

void Fauna.Serialization.Utf8FaunaWriter.WriteEndArray ( )

Writes the end of an array.

Definition at line 111 of file Utf8FaunaWriter.cs.

◆ WriteEndEscapedObject()

void Fauna.Serialization.Utf8FaunaWriter.WriteEndEscapedObject ( )

Writes the end of a specially tagged object.

Definition at line 94 of file Utf8FaunaWriter.cs.

◆ WriteEndObject()

void Fauna.Serialization.Utf8FaunaWriter.WriteEndObject ( )

Writes the end of an object.

Definition at line 76 of file Utf8FaunaWriter.cs.

◆ WriteEndRef()

void Fauna.Serialization.Utf8FaunaWriter.WriteEndRef ( )

Writes the end of a reference object.

Definition at line 129 of file Utf8FaunaWriter.cs.

◆ WriteFieldName()

void Fauna.Serialization.Utf8FaunaWriter.WriteFieldName ( string value )

Writes a field name for the next value.

Parameters

value The name of the field.

Definition at line 249 of file Utf8FaunaWriter.cs.

◆ WriteInt()

void Fauna.Serialization.Utf8FaunaWriter.WriteInt	(	string	fieldName,
		int	value
	)

Writes an integer value with a specific field name.

Parameters

fieldName	The name of the field.
value	The integer value to write.

Definition at line 162 of file Utf8FaunaWriter.cs.

◆ WriteIntValue()

void Fauna.Serialization.Utf8FaunaWriter.WriteIntValue ( int value )

Writes an integer value as a tagged element.

Parameters

value The integer value to write.

Definition at line 288 of file Utf8FaunaWriter.cs.

◆ WriteLong()

void Fauna.Serialization.Utf8FaunaWriter.WriteLong	(	string	fieldName,
		long	value
	)

Writes a long integer value with a specific field name.

Parameters

fieldName	The name of the field.
value	The long integer value to write.

Definition at line 173 of file Utf8FaunaWriter.cs.

◆ WriteLongValue()

void Fauna.Serialization.Utf8FaunaWriter.WriteLongValue ( long value )

Writes a long integer value as a tagged element.

Parameters

value The long integer value to write.

Definition at line 297 of file Utf8FaunaWriter.cs.

◆ WriteModule()

void Fauna.Serialization.Utf8FaunaWriter.WriteModule	(	string	fieldName,
		Module	value
	)

Writes a module value with a specific field name.

Parameters

fieldName	The name of the field.
value	The module value to write.

Definition at line 239 of file Utf8FaunaWriter.cs.

◆ WriteModuleValue()

void Fauna.Serialization.Utf8FaunaWriter.WriteModuleValue ( Module value )

Writes a module value as a tagged element.

Parameters

value The module value to write.

Definition at line 382 of file Utf8FaunaWriter.cs.

◆ WriteNull()

void Fauna.Serialization.Utf8FaunaWriter.WriteNull ( string fieldName )

Writes a null value with a specific field name.

Parameters

fieldName The name of the field.

Definition at line 228 of file Utf8FaunaWriter.cs.

◆ WriteNullValue()

void Fauna.Serialization.Utf8FaunaWriter.WriteNullValue ( )

Writes a null value to the stream.

Definition at line 373 of file Utf8FaunaWriter.cs.

◆ WriteStartArray()

void Fauna.Serialization.Utf8FaunaWriter.WriteStartArray ( )

Writes the beginning of an array.

Definition at line 103 of file Utf8FaunaWriter.cs.

◆ WriteStartEscapedObject()

void Fauna.Serialization.Utf8FaunaWriter.WriteStartEscapedObject ( )

Writes the beginning of a specially tagged object.

Definition at line 84 of file Utf8FaunaWriter.cs.

◆ WriteStartObject()

void Fauna.Serialization.Utf8FaunaWriter.WriteStartObject ( )

Writes the beginning of an object.

Definition at line 68 of file Utf8FaunaWriter.cs.

◆ WriteStartRef()

void Fauna.Serialization.Utf8FaunaWriter.WriteStartRef ( )

Writes the beginning of a reference object.

Definition at line 119 of file Utf8FaunaWriter.cs.

◆ WriteString()

void Fauna.Serialization.Utf8FaunaWriter.WriteString	(	string	fieldName,
		string	value
	)

Writes a string value with a specific field name.

Parameters

fieldName	The name of the field.
value	The string value to write.

Definition at line 184 of file Utf8FaunaWriter.cs.

◆ WriteStringValue()

void Fauna.Serialization.Utf8FaunaWriter.WriteStringValue ( string value )

Writes a string value as a tagged element.

Parameters

value The string value to write.

Definition at line 306 of file Utf8FaunaWriter.cs.

◆ WriteTaggedValue()

void Fauna.Serialization.Utf8FaunaWriter.WriteTaggedValue	(	string	tag,
		string	value
	)

Writes a tagged value in an object.

Parameters

tag	The tag to use for the value.
value	The value associated with the tag.

Definition at line 259 of file Utf8FaunaWriter.cs.

◆ WriteTime()

void Fauna.Serialization.Utf8FaunaWriter.WriteTime	(	string	fieldName,
		DateTime	value
	)

Writes a time value with a specific field name.

Parameters

fieldName	The name of the field.
value	The DateTime value to write.

Definition at line 206 of file Utf8FaunaWriter.cs.

◆ WriteTimeValue() [1/2]

void Fauna.Serialization.Utf8FaunaWriter.WriteTimeValue ( DateTime value )

Writes a date value as a tagged element.

Parameters

value The date value to write.

Definition at line 345 of file Utf8FaunaWriter.cs.

◆ WriteTimeValue() [2/2]

void Fauna.Serialization.Utf8FaunaWriter.WriteTimeValue ( DateTimeOffset value )

Writes a date value as a tagged element.

Parameters

value The date value to write.

Definition at line 355 of file Utf8FaunaWriter.cs.

The documentation for this class was generated from the following file:

/tmp/build/1a4543b4/repo.git/Fauna/Serialization/Utf8FaunaWriter.cs

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Utf8FaunaWriter() [1/2]

◆ Utf8FaunaWriter() [2/2]

Member Function Documentation

◆ Dispose()

◆ DisposeAsync()

◆ Flush()

◆ FlushAsync()

◆ WriteBoolean()

◆ WriteBooleanValue()

◆ WriteDate()

◆ WriteDateValue() [1/3]

◆ WriteDateValue() [2/3]

◆ WriteDateValue() [3/3]

◆ WriteDouble() [1/2]

◆ WriteDouble() [2/2]

◆ WriteDoubleValue() [1/2]

◆ WriteDoubleValue() [2/2]

◆ WriteEndArray()

◆ WriteEndEscapedObject()

◆ WriteEndObject()

◆ WriteEndRef()

◆ WriteFieldName()

◆ WriteInt()

◆ WriteIntValue()

◆ WriteLong()

◆ WriteLongValue()

◆ WriteModule()

◆ WriteModuleValue()

◆ WriteNull()

◆ WriteNullValue()

◆ WriteStartArray()

◆ WriteStartEscapedObject()

◆ WriteStartObject()

◆ WriteStartRef()

◆ WriteString()

◆ WriteStringValue()

◆ WriteTaggedValue()

◆ WriteTime()

◆ WriteTimeValue() [1/2]

◆ WriteTimeValue() [2/2]