Class YamlTextWriter
- Namespace
- Cuemon.Runtime.Serialization
- Assembly
- Cuemon.Core.dll
Represents a writer that provides a fast, non-cached, forward-only way to generate streams or files that contain YAML data. Implements the System.CodeDom.Compiler.IndentedTextWriter
[Obsolete("All YAML marshalling has been moved to its own assembly; Cuemon.Extensions.YamlDotNet. This member will be removed with next major version.")]
public class YamlTextWriter : IndentedTextWriter, IAsyncDisposable, IDisposable
- Inheritance
-
ObjectMarshalByRefObjectTextWriterIndentedTextWriterYamlTextWriter
- Implements
-
IAsyncDisposableIDisposable
- Inherited Members
-
IndentedTextWriter.DefaultTabStringIndentedTextWriter.Close()IndentedTextWriter.DisposeAsync()IndentedTextWriter.Flush()IndentedTextWriter.FlushAsync()IndentedTextWriter.FlushAsync(CancellationToken)IndentedTextWriter.OutputTabs()IndentedTextWriter.OutputTabsAsync()IndentedTextWriter.Write(Boolean)IndentedTextWriter.Write(Char)IndentedTextWriter.Write(Char[])IndentedTextWriter.Write(Char[], Int32, Int32)IndentedTextWriter.Write(Double)IndentedTextWriter.Write(Int32)IndentedTextWriter.Write(Int64)IndentedTextWriter.Write(Object)IndentedTextWriter.Write(Single)IndentedTextWriter.Write(String)IndentedTextWriter.Write(String, Object)IndentedTextWriter.Write(String, Object, Object)IndentedTextWriter.Write(String, Object[])IndentedTextWriter.WriteAsync(Char)IndentedTextWriter.WriteAsync(Char[], Int32, Int32)IndentedTextWriter.WriteAsync(ReadOnlyMemory<Char>, CancellationToken)IndentedTextWriter.WriteAsync(String)IndentedTextWriter.WriteAsync(StringBuilder, CancellationToken)IndentedTextWriter.WriteLine()IndentedTextWriter.WriteLine(Boolean)IndentedTextWriter.WriteLine(Char)IndentedTextWriter.WriteLine(Char[])IndentedTextWriter.WriteLine(Char[], Int32, Int32)IndentedTextWriter.WriteLine(Double)IndentedTextWriter.WriteLine(Int32)IndentedTextWriter.WriteLine(Int64)IndentedTextWriter.WriteLine(Object)IndentedTextWriter.WriteLine(Single)IndentedTextWriter.WriteLine(String)IndentedTextWriter.WriteLine(String, Object)IndentedTextWriter.WriteLine(String, Object, Object)IndentedTextWriter.WriteLine(String, Object[])IndentedTextWriter.WriteLine(UInt32)IndentedTextWriter.WriteLineAsync()IndentedTextWriter.WriteLineAsync(Char)IndentedTextWriter.WriteLineAsync(Char[], Int32, Int32)IndentedTextWriter.WriteLineAsync(ReadOnlyMemory<Char>, CancellationToken)IndentedTextWriter.WriteLineAsync(String)IndentedTextWriter.WriteLineAsync(StringBuilder, CancellationToken)IndentedTextWriter.WriteLineNoTabs(String)IndentedTextWriter.WriteLineNoTabsAsync(String)IndentedTextWriter.EncodingIndentedTextWriter.IndentIndentedTextWriter.InnerWriterIndentedTextWriter.NewLineTextWriter.CoreNewLineTextWriter.NullTextWriter.Dispose()TextWriter.Dispose(Boolean)TextWriter.Synchronized(TextWriter)TextWriter.Write(Decimal)TextWriter.Write(ReadOnlySpan<Char>)TextWriter.Write(String, Object, Object, Object)TextWriter.Write(StringBuilder)TextWriter.Write(UInt32)TextWriter.Write(UInt64)TextWriter.WriteAsync(Char[])TextWriter.WriteLine(Decimal)TextWriter.WriteLine(ReadOnlySpan<Char>)TextWriter.WriteLine(String, Object, Object, Object)TextWriter.WriteLine(StringBuilder)TextWriter.WriteLine(UInt64)TextWriter.WriteLineAsync(Char[])TextWriter.FormatProviderMarshalByRefObject.GetLifetimeService()MarshalByRefObject.InitializeLifetimeService()MarshalByRefObject.MemberwiseClone(Boolean)
Constructors
YamlTextWriter(TextWriter)
Initializes a new instance of the YamlTextWriter class.
public YamlTextWriter(TextWriter writer)
Parameters
writer
TextWriterThe System.IO.TextWriter to use for output.
YamlTextWriter(TextWriter, String)
Initializes a new instance of the YamlTextWriter class.
public YamlTextWriter(TextWriter writer, string tabString)
Parameters
writer
TextWriterThe System.IO.TextWriter to use for output.
tabString
StringThe tab string to use for indentation.
Properties
TokenType
Gets the type of the last processed YAML token.
public YamlTokenType TokenType { get; }
Property Value
- YamlTokenType
The type of the last processed YAML token.
Methods
WriteEndArray()
Denotes the end of a YAML array.
public void WriteEndArray()
WriteEndObject()
Denotes the end of a YAML object.
public void WriteEndObject()
WriteObject(Object, YamlSerializerOptions)
Serializes the specified value
into a YAML format.
public void WriteObject(object value, YamlSerializerOptions so)
Parameters
value
ObjectThe object to serialize.
so
YamlSerializerOptionsThe YamlSerializerOptions to use.
WriteObject(Object, Type, YamlSerializerOptions)
Serializes the specified value
into a YAML format.
public void WriteObject(object value, Type valueType, YamlSerializerOptions so)
Parameters
value
ObjectThe object to serialize.
valueType
TypeThe type of the
value
to convert.so
YamlSerializerOptionsThe YamlSerializerOptions to use.
WritePropertyName(String)
Writes the property name as the first part of a name/value pair of a YAML object.
public void WritePropertyName(string propertyName)
Parameters
propertyName
StringThe name of the YAML object.
WriteStartArray()
Writes the beginning of a YAML array.
public void WriteStartArray()
WriteStartObject()
Writes the beginning of a YAML object.
public void WriteStartObject()
WriteString(String, String)
Writes a property name specified as a string and a string text value as part of a name/value pair of a YAML object.
public void WriteString(string propertyName, string value)
Parameters
propertyName
StringThe name of the YAML object.
value
StringThe value to be written as part of the name/value pair of a YAML object.
WriteStringValue(String)
Writes a string text value as part of a name/value pair of a YAML object.
public void WriteStringValue(string value)
Parameters
value
StringThe value to be written as part of the name/value pair of a YAML object.