YamlValue Class

Definition

Namespace

Bodu.Text.Yaml.Nodes

Assembly

Bodu.Text.Yaml.dll

Package

Bodu.Text.Yaml 1.0.0

Source

YamlValue.cs

Represents a scalar node in a mutable YAML document object model.

public sealed class YamlValue : YamlNode

Inheritance

object

YamlNode

YamlValue

Inherited Members

YamlNode.Parse(string)

YamlNode.AsObject()

YamlNode.AsArray()

YamlNode.AsValue()

YamlNode.ToYamlString()

YamlNode.this[int]

YamlNode.this[string]

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ComparableExtensions.AtLeast<T>(T, T, IComparer<T>)

ComparableExtensions.AtMost<T>(T, T, IComparer<T>)

ComparableExtensions.IsEqualTo<T>(T, T, IComparer<T>)

ComparableExtensions.Max<T>(T, T, IComparer<T>)

ComparableExtensions.Min<T>(T, T, IComparer<T>)

Properties

ValueKind

Gets the kind of the scalar value.

public YamlValueKind ValueKind { get; }

Property Value

YamlValueKind

The value kind.

Methods

Create(bool)

Creates a boolean scalar.

public static YamlValue Create(bool value)

Parameters

value bool

The boolean value.

Returns

YamlValue

The scalar node.

Create(double)

Creates a floating-point scalar.

public static YamlValue Create(double value)

Parameters

value double

The floating-point value.

Returns

YamlValue

The scalar node.

Create(long)

Creates an integer scalar.

public static YamlValue Create(long value)

Parameters

value long

The integer value.

Returns

YamlValue

The scalar node.

Create(string)

Creates a string scalar.

public static YamlValue Create(string value)

Parameters

value string

The string value.

Returns

YamlValue

The scalar node.

GetValue<T>()

Gets the scalar value converted to the requested type.

public T GetValue<T>()

Returns

T

The converted value.

Type Parameters

T

The desired value type.

Exceptions

InvalidOperationException

The value cannot be converted to T.

WriteTo(Utf8YamlWriter)

Writes this node to the given writer.

public override void WriteTo(Utf8YamlWriter writer)

Parameters

writer Utf8YamlWriter

The writer to emit into.

Applies to

Product	Versions
.NET	8, 10