### Write Start Mapping Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Serialization.YamlWriter Writes the start of a YAML mapping. ```csharp public void WriteStartMapping() ``` -------------------------------- ### Initialize FlowMappingStart Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.FlowMappingStart.-ctor-SharpYaml.Mark-SharpYaml.Mark Constructs a new FlowMappingStart token with specified start and end marks. ```csharp public FlowMappingStart(Mark start, Mark end) ``` -------------------------------- ### Initialize DocumentStart Event Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Events.DocumentStart.-ctor-SharpYaml.Mark-SharpYaml.Mark Constructs a new DocumentStart instance using start and end marks. ```csharp public DocumentStart(Mark start, Mark end) ``` -------------------------------- ### Add SharpYaml Package Source: https://xoofx.github.io/SharpYaml Installs the SharpYaml NuGet package using the .NET CLI. ```shell dotnet add package SharpYaml ``` -------------------------------- ### DocumentStart Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Events.DocumentStart.-ctor-SharpYaml.Mark-SharpYaml.Mark Initializes a new instance of the DocumentStart class using start and end marks. ```APIDOC ## DocumentStart(Mark, Mark) Constructor ### Description Initializes a new instance of the DocumentStart class. ### Parameters #### Path Parameters - **start** (Mark) - Required - The start position of the event. - **end** (Mark) - Required - The end position of the event. ### Request Example public DocumentStart(Mark start, Mark end) ``` -------------------------------- ### Start Property Definition Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.YamlException.Start Details regarding the Start property used to identify the position of an event in the input stream. ```APIDOC ## Property: Start ### Description Gets the position in the input stream where the event that originated the exception starts. ### Definition Namespace: SharpYaml Assembly: SharpYaml.dll ### Property Signature ```csharp public Mark Start { get; } ``` ### Returns - **Mark** - The position marker in the input stream. ``` -------------------------------- ### Initialize DocumentStart Class Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.DocumentStart.-ctor Initializes a new instance of the DocumentStart class. No specific setup or imports are required beyond the class definition. ```csharp public DocumentStart() ``` -------------------------------- ### Initialize BlockMappingStart Class Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.BlockMappingStart.-ctor Use this constructor to create a new instance of the BlockMappingStart class. No specific setup or imports are required beyond the class definition. ```csharp public BlockMappingStart() ``` -------------------------------- ### Key Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.Key.-ctor-SharpYaml.Mark-SharpYaml.Mark Initializes a new instance of the Key class using start and end marks. ```APIDOC ## Constructor: SharpYaml.Tokens.Key ### Description Initializes a new instance of the Key class. ### Parameters - **start** (Mark) - Required - The start position of the token. - **end** (Mark) - Required - The end position of the token. ### Request Example ```csharp public Key(Mark start, Mark end) ``` ``` -------------------------------- ### Initialize Key instance in C# Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.Key.-ctor-SharpYaml.Mark-SharpYaml.Mark Constructor for the Key class requiring start and end Mark positions. ```csharp public Key(Mark start, Mark end) ``` -------------------------------- ### Accessing the Start property in C# Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.YamlException.Start Retrieves the Mark object representing the starting position of an event in the input stream. ```C# public Mark Start { get; } ``` -------------------------------- ### Initialize BlockMappingStart in C# Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.BlockMappingStart.-ctor-SharpYaml.Mark-SharpYaml.Mark Constructor for creating a new instance of the BlockMappingStart token using start and end marks. ```csharp public BlockMappingStart(Mark start, Mark end) ``` -------------------------------- ### Initialize BlockSequenceStart - C# Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.BlockSequenceStart.-ctor Use this constructor to create a new instance of the BlockSequenceStart class. No specific setup or imports are required beyond the SharpYaml library. ```csharp public BlockSequenceStart() ``` -------------------------------- ### GetDefaultTag(SequenceStart) Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Schemas.SchemaBase.GetDefaultTag-SharpYaml.Events.SequenceStart Gets the default tag for a SequenceStart event. ```APIDOC ## GetDefaultTag(SequenceStart) Method ### Description Gets the default tag for a SequenceStart event. ### Method protected abstract string GetDefaultTag(SequenceStart nodeEvent) ### Parameters #### Path Parameters * **nodeEvent** (SequenceStart) - Required - The node event. ### Returns String - The default tag for a seq. ``` -------------------------------- ### Initialize YamlSourceSpan Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Syntax.YamlSourceSpan.-ctor-SharpYaml.Mark-SharpYaml.Mark Use this constructor to create a YamlSourceSpan instance by providing the start and end marks. ```csharp public YamlSourceSpan(Mark start, Mark end) ``` -------------------------------- ### FlowSequenceStart Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.FlowSequenceStart.-ctor-SharpYaml.Mark-SharpYaml.Mark Initializes a new instance of the FlowSequenceStart class with specified start and end marks. ```APIDOC ## Constructor: FlowSequenceStart(Mark start, Mark end) ### Description Initializes a new instance of the FlowSequenceStart class. ### Parameters - **start** (Mark) - Required - The start position of the token. - **end** (Mark) - Required - The end position of the token. ### Syntax ```csharp public FlowSequenceStart(Mark start, Mark end) ``` ``` -------------------------------- ### StreamStart Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.StreamStart.-ctor-SharpYaml.Mark-SharpYaml.Mark Initializes a new instance of the StreamStart class with specified start and end positions. ```APIDOC ## StreamStart(Mark, Mark) Constructor ### Description Initializes a new instance of the StreamStart class. ### Method Constructor ### Endpoint N/A (Class Constructor) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) None (Constructor) #### Response Example None ``` -------------------------------- ### BlockSequenceStart Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.BlockSequenceStart.-ctor-SharpYaml.Mark-SharpYaml.Mark Initializes a new instance of the BlockSequenceStart class using start and end marks. ```APIDOC ## Constructor: BlockSequenceStart(Mark, Mark) ### Description Initializes a new instance of the BlockSequenceStart class. ### Parameters - **start** (Mark) - Required - The start position of the token. - **end** (Mark) - Required - The end position of the token. ### Signature `public BlockSequenceStart(Mark start, Mark end)` ``` -------------------------------- ### Initialize FlowSequenceStart Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.FlowSequenceStart.-ctor-SharpYaml.Mark-SharpYaml.Mark Constructor for creating a new instance of the FlowSequenceStart token with specified start and end marks. ```csharp public FlowSequenceStart(Mark start, Mark end) ``` -------------------------------- ### Define YAML Sequences Source: https://xoofx.github.io/SharpYaml/docs/yaml-basics Example of a sequence representing a list of items. ```YAML names: - Ada - Bob ``` -------------------------------- ### Install SharpYaml Package Source: https://xoofx.github.io/SharpYaml/docs/getting-started Use the .NET CLI to add the SharpYaml package to your project. This package supports .NET 8.0, 10.0, and Standard 2.0. ```shell dotnet add package SharpYaml ``` -------------------------------- ### Initialize StreamStart Class - C# Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Events.StreamStart Provides constructors for initializing a new instance of the StreamStart class. One constructor takes no arguments, while the other accepts Mark objects for start and end positions. ```csharp public StreamStart() ``` ```csharp public StreamStart(Mark start, Mark end) ``` -------------------------------- ### Initialize DocumentEnd Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.DocumentEnd.-ctor-SharpYaml.Mark-SharpYaml.Mark Use this constructor to create a new DocumentEnd token, specifying its start and end positions. ```csharp public DocumentEnd(Mark start, Mark end) ``` -------------------------------- ### Initialize BlockSequenceStart in C# Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.BlockSequenceStart.-ctor-SharpYaml.Mark-SharpYaml.Mark Constructor for creating a new instance of the BlockSequenceStart token using start and end marks. ```csharp public BlockSequenceStart(Mark start, Mark end) ``` -------------------------------- ### StreamStart NestingIncrease Property - C# Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Events.StreamStart Gets the variation in nesting depth caused by the stream start event. The value is typically 1 for start events. ```csharp public int NestingIncrease { get; } ``` -------------------------------- ### Initialize SemanticErrorException Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.SemanticErrorException.-ctor Initializes a new instance of the SemanticErrorException class. No specific setup is required. ```csharp public SemanticErrorException() ``` -------------------------------- ### Get Serialized Member Name (C#) Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Serialization.YamlPropertyNameAttribute.Name Use this property to get the name of the member as it is serialized by SharpYaml. No specific setup is required beyond having an instance of the class containing this property. ```csharp public string Name { get; } ``` -------------------------------- ### Initialize FlowMappingEnd Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.FlowMappingEnd.-ctor-SharpYaml.Mark-SharpYaml.Mark Creates a new FlowMappingEnd token instance using start and end marks. ```csharp public FlowMappingEnd(Mark start, Mark end) ``` -------------------------------- ### DocumentEnd Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.DocumentEnd.-ctor-SharpYaml.Mark-SharpYaml.Mark Initializes a new instance of the DocumentEnd class using start and end marks. ```APIDOC ## Constructor: DocumentEnd(Mark start, Mark end) ### Description Initializes a new instance of the DocumentEnd class. ### Parameters - **start** (Mark) - Required - The start position of the token. - **end** (Mark) - Required - The end position of the token. ### Request Example ```csharp public DocumentEnd(Mark start, Mark end) ``` ``` -------------------------------- ### Initialize DocumentStart instance Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Events.DocumentStart.-ctor-SharpYaml.Tokens.VersionDirective-SharpYaml.Ta-f849a51b2609 Constructor for creating a new DocumentStart event with specified version, tags, implicit status, and marks. ```csharp public DocumentStart(VersionDirective? version, TagDirectiveCollection? tags, bool isImplicit, Mark start, Mark end) ``` -------------------------------- ### Run All Benchmarks Source: https://xoofx.github.io/SharpYaml/benchmarks Execute all benchmark scenarios from the command line. Ensure you are in the 'src' directory. ```bash cd src dotnet run -c Release --project SharpYaml.Benchmarks -- --filter "*" ``` -------------------------------- ### Value Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.Value.-ctor-SharpYaml.Mark-SharpYaml.Mark Initializes a new instance of the Value class using start and end marks. ```APIDOC ## Constructor: Value(Mark start, Mark end) ### Description Initializes a new instance of the Value class. ### Parameters - **start** (Mark) - Required - The start position of the token. - **end** (Mark) - Required - The end position of the token. ### Request Example ```csharp public Value(Mark start, Mark end) ``` ``` -------------------------------- ### BlockMappingStart() Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.BlockMappingStart.-ctor Initializes a new instance of the BlockMappingStart class. ```APIDOC ## BlockMappingStart() Constructor ### Description Initializes a new instance of the BlockMappingStart class. ### Method public ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### DocumentStart Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Events.DocumentStart.-ctor-SharpYaml.Tokens.VersionDirective-SharpYaml.Ta-f849a51b2609 Initializes a new instance of the DocumentStart class. ```APIDOC ## DocumentStart Constructor ### Description Initializes a new instance of the DocumentStart class. ### Method Constructor ### Endpoint N/A ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) None #### Response Example None ### C# Signature ```csharp public DocumentStart(VersionDirective? version, TagDirectiveCollection? tags, bool isImplicit, Mark start, Mark end) ``` ### Parameters - **version** (VersionDirective?) - The version. - **tags** (TagDirectiveCollection?) - The tags. - **isImplicit** (Boolean) - Indicates whether the event is implicit. - **start** (Mark) - The start position of the event. - **end** (Mark) - The end position of the event. ``` -------------------------------- ### Peek(Int32) Method Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.ILookAheadBuffer.Peek-System.Int32 Gets the character at the specified offset. ```APIDOC ## Peek(Int32) Method ### Description Gets the character at the specified offset. ### Method N/A (This is a method definition, not an API endpoint) ### Endpoint N/A ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Request Example N/A ### Response #### Success Response (200) - **Return Value** (Char) - The character at the specified offset. #### Response Example N/A ### Additional Information - **Namespace**: SharpYaml - **Assembly**: SharpYaml.dll ``` -------------------------------- ### Initialize MappingStart Event Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Events.MappingStart.-ctor-System.String-System.String-System.Boolean-Shar-a59cc3d163a3 Use this constructor to create a new MappingStart event. It requires parameters for anchor, tag, implicit status, style, and start/end marks. ```csharp public MappingStart(string? anchor, string? tag, bool isImplicit, YamlStyle style, Mark start, Mark end) ``` -------------------------------- ### Initialize DocumentEnd Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.DocumentEnd.-ctor Initializes a new instance of the DocumentEnd class. No specific setup is required beyond standard C# compilation. ```csharp public DocumentEnd() ``` -------------------------------- ### Initialize BlockEntry Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.BlockEntry.-ctor-SharpYaml.Mark-SharpYaml.Mark Use this constructor to create a new BlockEntry instance. It requires the start and end positions of the token. ```csharp public BlockEntry(Mark start, Mark end) ``` -------------------------------- ### Token(Mark, Mark) Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.Token.-ctor-SharpYaml.Mark-SharpYaml.Mark Initializes a new instance of the Token class using start and end marks. ```APIDOC ## Token(Mark, Mark) Constructor ### Description Initializes a new instance of the Token class. ### Parameters - **start** (Mark) - Required - The start position of the token. - **end** (Mark) - Required - The end position of the token. ``` -------------------------------- ### FlowMappingStart() Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.FlowMappingStart.-ctor Initializes a new instance of the FlowMappingStart class. ```APIDOC ## FlowMappingStart() Constructor ### Description Initializes a new instance of the FlowMappingStart class. ### Method Constructor ### Endpoint N/A ### Parameters None ### Request Example None ### Response None ### Error Handling None ``` -------------------------------- ### Peek() Method Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.EventReader.Peek--1 Gets the next event without consuming it. ```APIDOC ## Peek() Method ### Description Gets the next event without consuming it. ### Namespace SharpYaml ### Assembly SharpYaml.dll ### Method Signature ```csharp public T? Peek() where T : ParsingEvent ``` ### Type Parameters * **T** (Type) - Type of the ParsingEvent. ### Returns * **{T}** - Returns the current event if it is of type T; otherwise returns null. ``` -------------------------------- ### Initialize FlowEntry Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.FlowEntry.-ctor-SharpYaml.Mark-SharpYaml.Mark Constructor for creating a new FlowEntry instance using start and end marks. ```csharp public FlowEntry(Mark start, Mark end) ``` -------------------------------- ### MappingEnd Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Events.MappingEnd.-ctor-SharpYaml.Mark-SharpYaml.Mark Initializes a new instance of the MappingEnd class with specified start and end marks. ```APIDOC ## MappingEnd(Mark, Mark) Constructor ### Description Initializes a new instance of the MappingEnd class. ### Parameters #### Path Parameters - **start** (Mark) - Required - The start position of the event. - **end** (Mark) - Required - The end position of the event. ### Request Example public MappingEnd(Mark start, Mark end) ``` -------------------------------- ### Get Prefix Property Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.TagDirective.Prefix Retrieves the prefix string. This property is read-only. ```csharp public string Prefix { get; } ``` -------------------------------- ### SequenceEnd Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Events.SequenceEnd.-ctor-SharpYaml.Mark-SharpYaml.Mark Initializes a new instance of the SequenceEnd class with specified start and end marks. ```APIDOC ## Constructor: SequenceEnd(Mark, Mark) ### Description Initializes a new instance of the SequenceEnd class. ### Parameters - **start** (Mark) - Required - The start position of the event. - **end** (Mark) - Required - The end position of the event. ### Request Example ```csharp public SequenceEnd(Mark start, Mark end) ``` ``` -------------------------------- ### Get Suffix Property Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.Tag.Suffix Retrieves the suffix value. This is a read-only property. ```csharp public string Suffix { get; } ``` -------------------------------- ### Initialize Token Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.Token.-ctor-SharpYaml.Mark-SharpYaml.Mark Initializes a new instance of the Token class using start and end marks. ```csharp protected Token(Mark start, Mark end) ``` -------------------------------- ### MappingStart Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Events.MappingStart.-ctor-System.String-System.String-System.Boolean-Shar-a59cc3d163a3 Initializes a new instance of the MappingStart class. ```APIDOC ## MappingStart Constructor ### Description Initializes a new instance of the MappingStart class. ### Method Constructor ### Endpoint N/A ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) None #### Response Example None ### Parameters - **anchor** (String?) - Optional - The anchor. - **tag** (String?) - Optional - The tag. - **isImplicit** (Boolean) - Required - Indicates whether the event is implicit. - **style** (YamlStyle) - Required - The style of the mapping. - **start** (Mark) - Required - The start position of the event. - **end** (Mark) - Required - The end position of the event. ``` -------------------------------- ### GET /SharpYaml/Serialization/GetConverter Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Serialization.YamlReaderWriterBase.GetConverter-System.Type Retrieves a converter instance for a specified CLR type. ```APIDOC ## GetConverter(Type) ### Description Gets a converter that can handle the specified typeToConvert. ### Method Method Call ### Parameters #### Parameters - **typeToConvert** (Type) - Required - The CLR type to resolve. ### Returns - **YamlConverter** - The converter for typeToConvert. ``` -------------------------------- ### IndexOf(YamlElement) Method Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Model.YamlSequence.IndexOf-SharpYaml.Model.YamlElement Gets the zero-based index of the specified item. ```APIDOC ## IndexOf(YamlElement) Method ### Description Gets the zero-based index of the specified item. ### Method public int IndexOf(YamlElement item) ### Endpoint N/A (Method documentation) ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Request Example N/A ### Response #### Success Response (200) N/A #### Response Example N/A ### Parameters - **item** (YamlElement) - Required - The YamlElement to find the index of. ### Returns - **Int32** - The zero-based index of the item if found; otherwise, -1. ``` -------------------------------- ### Get EventType Property Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Model.DocumentContentsChanged.EventType Retrieves the event type. This property is read-only. ```csharp public override TrackerEventType EventType { get; } ``` -------------------------------- ### Initialize SharpYaml Key Class Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.Key.-ctor Use this constructor to create a new instance of the Key class in SharpYaml. ```csharp public Key() ``` -------------------------------- ### AnchorAlias Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Events.AnchorAlias.-ctor-System.String-SharpYaml.Mark-SharpYaml.Mark Initializes a new instance of the AnchorAlias class with the specified value, start, and end marks. ```APIDOC ## AnchorAlias Constructor ### Description Initializes a new instance of the AnchorAlias class. ### Method Constructor ### Endpoint N/A (Class Constructor) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```csharp AnchorAlias alias = new AnchorAlias("myAlias", startMark, endMark); ``` ### Response #### Success Response (200) N/A (Constructor) #### Response Example N/A (Constructor) ``` -------------------------------- ### Initialize YamlException with a message Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.YamlException.-ctor-System.String Use this constructor to create a new instance of YamlException with a specific error message. No specific setup is required beyond having the SharpYaml library available. ```csharp public YamlException(string message) ``` -------------------------------- ### Initialize FlowSequenceEnd Instance Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.FlowSequenceEnd.-ctor Use this constructor to create a new instance of the FlowSequenceEnd class. No specific setup or imports are required beyond the SharpYaml library. ```csharp public FlowSequenceEnd() ``` -------------------------------- ### Initialize FlowMappingStart instance Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.FlowMappingStart.-ctor Constructor for creating a new instance of the FlowMappingStart class. ```csharp public FlowMappingStart() ``` -------------------------------- ### GET Tracker Property Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Model.YamlStream.Tracker Retrieves the YamlNodeTracker instance associated with the current object. ```APIDOC ## GET Tracker Property ### Description Gets the tracker associated with the model. ### Returns - **YamlNodeTracker** - The tracker instance or null if not set. ``` -------------------------------- ### SyntaxErrorException(Mark, Mark, String) Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.SyntaxErrorException.-ctor-SharpYaml.Mark-SharpYaml.Mark-System.String Initializes a new instance of the SyntaxErrorException class with specified start and end marks and an error message. ```APIDOC ## SyntaxErrorException(Mark, Mark, String) Constructor ### Description Initializes a new instance of the SyntaxErrorException class. ### Parameters - **start** (Mark) - Required - The starting mark of the error. - **end** (Mark) - Required - The ending mark of the error. - **message** (String) - Required - The error message describing the syntax issue. ### Constructor Signature ```csharp public SyntaxErrorException(Mark start, Mark end, string message) ``` ``` -------------------------------- ### Get Value Property Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Events.Scalar.Value Retrieves the string value of an event. This property is read-only. ```csharp public string Value { get; } ``` -------------------------------- ### BlockMappingStart Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.BlockMappingStart.-ctor-SharpYaml.Mark-SharpYaml.Mark Initializes a new instance of the BlockMappingStart class. ```APIDOC ## BlockMappingStart(Mark, Mark) ### Description Initializes a new instance of the BlockMappingStart class. ### Method Constructor ### Parameters #### Path Parameters - **start** (Mark) - Required - The start position of the token. - **end** (Mark) - Required - The end position of the token. ``` -------------------------------- ### Initialize DocumentEnd Event Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Events.DocumentEnd.-ctor-System.Boolean-SharpYaml.Mark-SharpYaml.Mark Use this constructor to create a DocumentEnd event, specifying if it's implicit and its start and end positions. ```csharp public DocumentEnd(bool isImplicit, Mark start, Mark end) ``` -------------------------------- ### Initialize Version class Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Version.-ctor-System.Int32-System.Int32 Constructor for creating a new Version instance with specified major and minor version numbers. ```csharp public Version(int major, int minor) ``` -------------------------------- ### ForceIndentLess Property Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Emitter.ForceIndentLess Gets or sets a value indicating whether to always indent. ```APIDOC ## ForceIndentLess Property ### Description Gets or sets a value indicating whether [always indent]. ### Namespace SharpYaml ### Assembly SharpYaml.dll ### Returns Boolean - `true` if [always indent]; otherwise, `false`. ``` -------------------------------- ### Initialize SemanticErrorException Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.SemanticErrorException.-ctor-SharpYaml.Mark-SharpYaml.Mark-System.String Initializes a new instance of the SemanticErrorException class with start, end, and message parameters. ```csharp public SemanticErrorException(Mark start, Mark end, string message) ``` -------------------------------- ### Initialize StreamStart Event Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Events.StreamStart.-ctor-SharpYaml.Mark-SharpYaml.Mark Use this constructor to create a new StreamStart event, specifying the start and end positions of the event within the source. ```csharp public StreamStart(Mark start, Mark end) ``` -------------------------------- ### Define YAML Mappings Source: https://xoofx.github.io/SharpYaml/docs/yaml-basics Example of a nested mapping structure representing an object. ```YAML server: host: localhost port: 8080 ``` -------------------------------- ### IsReflectionEnabledByDefault Property Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.YamlSerializer.IsReflectionEnabledByDefault Gets a value indicating whether reflection-based serialization is enabled by default. ```APIDOC ## IsReflectionEnabledByDefault Property ### Description Gets a value indicating whether reflection-based serialization is enabled by default. ### Namespace SharpYaml ### Assembly SharpYaml.dll ### Returns Boolean ``` -------------------------------- ### Tag Property Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.YamlDerivedType.Tag Gets or sets an optional explicit YAML tag for the derived type. ```APIDOC ## Tag Property ### Description Gets or sets an optional explicit YAML tag for the derived type. ### Namespace SharpYaml ### Assembly SharpYaml.dll ### Returns String ``` -------------------------------- ### CopyTo(YamlDocument[], Int32) Method Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Model.YamlStream.CopyTo-SharpYaml.Model.YamlDocument---System.Int32 Copies the elements of the current SharpYaml collection to an array, starting at a specified index. ```APIDOC ## CopyTo(YamlDocument[], Int32) Method ### Description Copies the elements to an array starting at the specified index. ### Method Public void ### Endpoint N/A (Method within a class) ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Request Example N/A ### Response #### Success Response (200) N/A (void method) #### Response Example N/A ### Parameters - **array** (YamlDocument[]) - The one-dimensional Array that is the destination of the elements copied from the collection. The Array must have zero-based indexing. - **arrayIndex** (Int32) - The zero-based index in array at which the copying begins. ``` -------------------------------- ### IncludeTrivia Property Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Syntax.YamlSyntaxOptions.IncludeTrivia Gets or sets a value indicating whether trivia (whitespace/newline/comments) should be included. ```APIDOC ## IncludeTrivia Property ### Description Gets or sets a value indicating whether trivia (whitespace/newline/comments) should be included. ### Namespace SharpYaml.Syntax ### Assembly SharpYaml.dll ### Returns Boolean ``` -------------------------------- ### Key() Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.Key.-ctor Initializes a new instance of the Key class. ```APIDOC ## Key() Constructor ### Description Initializes a new instance of the Key class. ### Method Constructor ### Endpoint N/A ### Parameters None ### Request Example None ### Response None ### Remarks Namespace: SharpYaml.Tokens Assembly: SharpYaml.dll ``` -------------------------------- ### GET Options Property Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Serialization.YamlSerializerContext.Options Retrieves the YamlSerializerOptions instance associated with the current serialization context. ```APIDOC ## GET Options Property ### Description Gets the options instance associated with the current serialization context. This instance is used by generated metadata properties on the context. ### Returns - **YamlSerializerOptions** - The configuration options instance. ``` -------------------------------- ### SequenceStart Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Events.SequenceStart.-ctor-System.String-System.String-System.Boolean-Sha-31d79f11b336 Initializes a new instance of the SequenceStart class with specified anchor, tag, implicit status, style, and position. ```APIDOC ## SequenceStart(String?, String?, Boolean, YamlStyle, Mark, Mark) Constructor ### Description Initializes a new instance of the SequenceStart class. ### Method Constructor ### Endpoint N/A (Class Constructor) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) None #### Response Example None ### Parameters - **anchor** (String) - Optional - The anchor. - **tag** (String) - Optional - The tag. - **isImplicit** (Boolean) - Optional - If set to `true` [is implicit]. - **style** (YamlStyle) - Optional - The style. - **start** (Mark) - Required - The start position of the event. - **end** (Mark) - Required - The end position of the event. ``` -------------------------------- ### Get YamlSerializerOptions Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Serialization.YamlReaderWriterBase.Options Access the YamlSerializerOptions associated with a reader or writer instance. This property is read-only. ```csharp public YamlSerializerOptions Options { get; } ``` -------------------------------- ### Configure YAML Serialization Options Source: https://xoofx.github.io/SharpYaml/docs/getting-started Customize serialization behavior using YamlSerializerOptions. This example sets property naming policy to camel case, enables indented writing, specifies indent size, and ignores null values when writing. ```csharp using System.Text.Json; using SharpYaml; var options = new YamlSerializerOptions { PropertyNamingPolicy = JsonNamingPolicy.CamelCase, WriteIndented = true, IndentSize = 4, DefaultIgnoreCondition = YamlIgnoreCondition.WhenWritingNull, }; var yaml = YamlSerializer.Serialize(config, options); var config2 = YamlSerializer.Deserialize(yaml, options); ``` -------------------------------- ### Get Order Property Value Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Serialization.YamlPropertyOrderAttribute.Order Retrieves the order value for serialization. This is a read-only property. ```csharp public int Order { get; } ``` -------------------------------- ### WriteStartSequence() Method Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Serialization.YamlWriter.WriteStartSequence Documentation for the WriteStartSequence method used to begin a sequence in YAML serialization. ```APIDOC ## WriteStartSequence() ### Description Writes the start of a sequence to the YAML output. ### Method Public Method ### Definition Namespace: SharpYaml.Serialization Assembly: SharpYaml.dll ``` -------------------------------- ### Initialize StreamEnd Token Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.StreamEnd.-ctor-SharpYaml.Mark-SharpYaml.Mark Use this constructor to create a StreamEnd token, specifying its start and end positions within the input stream. ```csharp public StreamEnd(Mark start, Mark end) ``` -------------------------------- ### GET Default Property Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.ReflectionYamlTypeInfoResolver.Default Retrieves the shared default reflection resolver instance for SharpYaml. ```APIDOC ## GET Default ### Description Gets a shared default reflection resolver instance. ### Returns - **ReflectionYamlTypeInfoResolver** - The shared default instance. ``` -------------------------------- ### FlowSequenceStart() Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.FlowSequenceStart.-ctor Initializes a new instance of the FlowSequenceStart class. ```APIDOC ## FlowSequenceStart() Constructor ### Description Initializes a new instance of the FlowSequenceStart class. ### Definition - **Namespace**: SharpYaml.Tokens - **Assembly**: SharpYaml.dll ### Syntax ```csharp public FlowSequenceStart() ``` ``` -------------------------------- ### SequenceStartChanged Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Model.SequenceStartChanged.-ctor-SharpYaml.Model.YamlSequence-System.Coll-1d20794051ef Initializes a new instance of the SequenceStartChanged class. This constructor is used when a sequence's start marker changes. ```csharp public SequenceStartChanged(YamlSequence node, IList parentPaths, SequenceStart oldValue, SequenceStart newValue) ``` -------------------------------- ### IndexOf(KeyValuePair) Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Model.YamlMapping.IndexOf-System.Collections.Generic.KeyValuePair-SharpYa-3d9012946db0 Gets the zero-based index of the specified item in the collection. ```APIDOC ## IndexOf(KeyValuePair) ### Description Gets the zero-based index of the specified item. ### Method Public ### Endpoint N/A (Method within a class) ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Request Example N/A ### Response #### Success Response (200) - **Int32** - The zero-based index of the specified item. #### Response Example N/A ``` -------------------------------- ### BlockSequenceStart() Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.BlockSequenceStart.-ctor Initializes a new instance of the BlockSequenceStart class. ```APIDOC ## BlockSequenceStart() Constructor ### Description Initializes a new instance of the BlockSequenceStart class. ### Namespace SharpYaml.Tokens ### Assembly SharpYaml.dll ### View source View source ### Method Signature ```csharp public BlockSequenceStart() ``` ### Request Example ```csharp // No request body for constructor ``` ### Response Example ```json // Constructors do not return values in the traditional sense. // An instance of BlockSequenceStart is created. ``` ``` -------------------------------- ### EndOfInput Property Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.LookAheadBuffer.EndOfInput Gets a value indicating whether the end of the input reader has been reached. ```APIDOC ## EndOfInput Property ### Description Gets a value indicating whether the end of the input reader has been reached. ### Namespace SharpYaml ### Assembly SharpYaml.dll ### Implements EndOfInput ### Returns Boolean ### Code Example ```csharp public bool EndOfInput { get; } ``` ``` -------------------------------- ### Initialize StreamStart in C# Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.StreamStart.-ctor Constructor for creating a new instance of the StreamStart class. ```csharp public StreamStart() ``` -------------------------------- ### Get Old Child Property Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Model.ChildChangedEventArgs-2.OldChild Retrieves the old child element. This property is read-only. ```csharp public TChild? OldChild { get; } ``` -------------------------------- ### Initialize Tag instance Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.Tag.-ctor-System.String-System.String-SharpYaml.Mark-SharpYaml.Mark Constructor for creating a new Tag token with specified handle, suffix, and position marks. ```csharp public Tag(string handle, string suffix, Mark start, Mark end) ``` -------------------------------- ### EndOfInput Property Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.ILookAheadBuffer.EndOfInput Gets a value indicating whether the end of the input reader has been reached. ```APIDOC ## EndOfInput Property ### Description Gets a value indicating whether the end of the input reader has been reached. ### Namespace SharpYaml ### Assembly SharpYaml.dll ### Returns Boolean - True if the end of the input has been reached; otherwise, false. ``` -------------------------------- ### Initialize SequenceEnd Event Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Events.SequenceEnd.-ctor-SharpYaml.Mark-SharpYaml.Mark Use this constructor to create a new SequenceEnd event, specifying its start and end positions within the source. ```csharp public SequenceEnd(Mark start, Mark end) ``` -------------------------------- ### Run Source-Generated Benchmarks Source: https://xoofx.github.io/SharpYaml/benchmarks Execute only the source-generated serialization benchmark scenarios. Navigate to the 'src' directory first. ```bash cd src dotnet run -c Release --project SharpYaml.Benchmarks -- --filter "*SourceGenerated*" ``` -------------------------------- ### Integer Discriminator Setup (YAML) Source: https://xoofx.github.io/SharpYaml/docs/serialization/polymorphism Configure integer discriminators for YAML polymorphic types using `YamlDerivedTypeAttribute` with an integer value. This enables numeric identification for derived types in YAML. ```csharp [YamlPolymorphic] [YamlDerivedType(typeof(Dog), 1)] [YamlDerivedType(typeof(Cat), 2)] public abstract class Animal { public string Name { get; set; } = ""; } ``` -------------------------------- ### YamlException Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.YamlException.-ctor-SharpYaml.Mark-SharpYaml.Mark-System.String Initializes a new instance of the YamlException class with start, end, and message parameters. ```APIDOC ## YamlException Constructor ### Description Initializes a new instance of the YamlException class. ### Method Constructor ### Endpoint N/A (Class Constructor) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (N/A) N/A #### Response Example None ### Parameters - **start** (Mark) - Description: The starting position of the error. - **end** (Mark) - Description: The ending position of the error. - **message** (String) - Description: The error message. ``` -------------------------------- ### Initialize FlowSequenceStart in C# Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.FlowSequenceStart.-ctor Constructor for creating a new instance of the FlowSequenceStart class. ```csharp public FlowSequenceStart() ``` -------------------------------- ### SequenceStart Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Events.SequenceStart.-ctor-System.String-System.String-System.Boolean-Sha-31d79f11b336 Initializes a new instance of the SequenceStart class. Use this constructor when creating a SequenceStart event with explicit anchor, tag, implicitness, style, and position information. ```csharp public SequenceStart(string? anchor, string? tag, bool isImplicit, YamlStyle style, Mark start, Mark end) ``` -------------------------------- ### Integer Discriminator Setup (JSON) Source: https://xoofx.github.io/SharpYaml/docs/serialization/polymorphism Define integer discriminators for polymorphic types using `JsonDerivedTypeAttribute` with an integer value. This allows numeric identifiers for derived types. ```csharp [JsonPolymorphic(TypeDiscriminatorPropertyName = "$type")] [JsonDerivedType(typeof(Dog), 1)] [JsonDerivedType(typeof(Cat), 2)] public abstract class Animal { public string Name { get; set; } = ""; } ``` -------------------------------- ### StreamStart Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Events.StreamStart.-ctor-SharpYaml.Mark-SharpYaml.Mark Initializes a new instance of the StreamStart class. ```APIDOC ## StreamStart(Mark, Mark) Constructor ### Description Initializes a new instance of the StreamStart class. ### Parameters #### start - **start** (Mark) - The start position of the event. #### end - **end** (Mark) - The end position of the event. ``` -------------------------------- ### StreamEnd Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.StreamEnd.-ctor-SharpYaml.Mark-SharpYaml.Mark Initializes a new instance of the StreamEnd class with specified start and end marks. ```APIDOC ## Constructor: StreamEnd(Mark, Mark) ### Description Initializes a new instance of the StreamEnd class. ### Parameters - **start** (Mark) - Required - The start position of the token. - **end** (Mark) - Required - The end position of the token. ### Signature ```csharp public StreamEnd(Mark start, Mark end) ``` ``` -------------------------------- ### Initialize VersionDirective Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.VersionDirective.-ctor-SharpYaml.Version Constructor for creating a new VersionDirective instance. ```csharp public VersionDirective(Version version) ``` -------------------------------- ### Initialize YamlTypeInfo with Options Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.YamlTypeInfo-1.-ctor-SharpYaml.YamlSerializerOptions Use this constructor to initialize a YamlTypeInfo object with specific serializer options. The options parameter provides configuration for the YAML serializer. ```csharp protected YamlTypeInfo(YamlSerializerOptions options) ``` -------------------------------- ### Quick YAML Serialization and Deserialization Source: https://xoofx.github.io/SharpYaml Demonstrates basic YAML serialization to a string and deserialization back into a .NET object using YamlSerializer. Ensure the 'Person' class is defined elsewhere. ```csharp using SharpYaml; var yaml = YamlSerializer.Serialize(new { Name = "Ada", Age = 37 }); // Name: Ada // Age: 37 var model = YamlSerializer.Deserialize(yaml); ``` -------------------------------- ### Emit a YAML mapping Source: https://xoofx.github.io/SharpYaml/docs/low-level/emitter Demonstrates manual construction of a YAML document using event streams. Requires SharpYaml.Events namespace. ```C# using System.IO; using SharpYaml; using SharpYaml.Events; var writer = new StringWriter(); var emitter = new Emitter(writer); emitter.Emit(new StreamStart()); emitter.Emit(new DocumentStart()); emitter.Emit(new MappingStart()); emitter.Emit(new Scalar("name")); emitter.Emit(new Scalar("Ada")); emitter.Emit(new Scalar("age")); emitter.Emit(new Scalar("37")); emitter.Emit(new MappingEnd()); emitter.Emit(new DocumentEnd()); emitter.Emit(new StreamEnd()); var yaml = writer.ToString(); ``` -------------------------------- ### Version(Int32, Int32) Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Version.-ctor-System.Int32-System.Int32 Initializes a new instance of the Version class with the specified major and minor version numbers. ```APIDOC ## Version(Int32, Int32) Constructor ### Description Initializes a new instance of the Version class. ### Method Constructor ### Endpoint N/A (Class Constructor) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```csharp // Example usage: var version = new SharpYaml.Version(1, 0); ``` ### Response #### Success Response (N/A for Constructors) N/A #### Response Example N/A ### Parameters major Int32 The major version number. minor Int32 The minor version number. ``` -------------------------------- ### Mark Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Mark.-ctor-System.Int32-System.Int32-System.Int32 Initializes a new mark at the specified source location. ```APIDOC ## Mark(Int32, Int32, Int32) Constructor ### Description Initializes a new mark at the specified source location. ### Method Constructor ### Endpoint N/A ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Request Example N/A ### Response #### Success Response (200) N/A #### Response Example N/A ### Parameters #### index (Int32) - Description: The index of the mark. #### line (Int32) - Description: The line number of the mark. #### column (Int32) - Description: The column number of the mark. ``` -------------------------------- ### BlockEnd Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.BlockEnd.-ctor-SharpYaml.Mark-SharpYaml.Mark Initializes a new instance of the BlockEnd class using start and end marks. ```APIDOC ## Constructor: SharpYaml.Tokens.BlockEnd ### Description Initializes a new instance of the BlockEnd class. ### Parameters - **start** (Mark) - Required - The start position of the token. - **end** (Mark) - Required - The end position of the token. ### Request Example ```csharp public BlockEnd(Mark start, Mark end) ``` ``` -------------------------------- ### Create(String, YamlSerializerOptions?) Method Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Serialization.YamlReader.Create-System.String-SharpYaml.YamlSerializerOptions Initializes a new YamlReader instance for parsing YAML content provided as a string. ```APIDOC ## static Create(string yaml, YamlSerializerOptions? options) ### Description Creates a YAML reader over a string payload. ### Parameters - **yaml** (String) - Required - The YAML payload. - **options** (YamlSerializerOptions) - Optional - Options used for parsing behaviors such as reference handling. ### Returns - **YamlReader** - A reader instance configured for the provided string. ``` -------------------------------- ### Initialize SyntaxErrorException Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.SyntaxErrorException.-ctor-SharpYaml.Mark-SharpYaml.Mark-System.String Initializes a new instance of the SyntaxErrorException class. Requires SharpYaml.dll assembly. ```csharp public SyntaxErrorException(Mark start, Mark end, string message) ``` -------------------------------- ### UseSchema Property Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.YamlSerializerOptions.UseSchema Gets or sets a value indicating whether scalar deserialization should resolve through Schema. ```APIDOC ## UseSchema Property ### Description Gets or sets a value indicating whether scalar deserialization should resolve through Schema. ### Returns Boolean ### Remarks When `false`, built-in converters use a fast span-based path for common YAML 1.2 scalars while still honoring quoted scalars as strings. When `true`, scalar resolution goes through the selected Schema. ``` -------------------------------- ### Initialize YamlSyntaxToken Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Syntax.YamlSyntaxToken.-ctor-SharpYaml.Syntax.YamlSyntaxKind-SharpYaml.Sy-7c1a5db90359 Use this constructor to create a new YamlSyntaxToken. It requires the token kind, its source span, and the text content of the token. ```csharp public YamlSyntaxToken(YamlSyntaxKind kind, YamlSourceSpan span, string text) ``` -------------------------------- ### Get Node Property - C# Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Model.ChildEventArgs-2.Node This property retrieves the parent node. It is part of the SharpYaml.Model namespace. ```csharp public TParent Node { get; } ``` -------------------------------- ### Initialize SyntaxErrorException Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.SyntaxErrorException.-ctor-System.String-System.Exception Constructor for creating a new SyntaxErrorException instance. ```csharp public SyntaxErrorException(string message, Exception inner) ``` -------------------------------- ### SharpYaml.Syntax Namespace Source: https://xoofx.github.io/SharpYaml/api Offers lossless YAML syntax tree APIs with source location information for roundtripping and tooling. ```APIDOC ## SharpYaml.Syntax Namespace ### Description Lossless YAML syntax tree APIs with source locations for roundtripping and tooling. ### Method N/A (Library Namespace) ### Endpoint N/A (Library Namespace) ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### IsNull(ReadOnlySpan) Method Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Serialization.YamlScalar.IsNull-System.ReadOnlySpan-System.Char- Determines whether a scalar represents YAML null (for example `null` or `~`). ```APIDOC ## IsNull(ReadOnlySpan) Method ### Description Determines whether a scalar represents YAML null (for example `null` or `~`). ### Method `public static bool IsNull(ReadOnlySpan value)` ### Parameters #### Path Parameters * None #### Query Parameters * None #### Request Body * None ### Request Example * None ### Response #### Success Response (200) * **Returns** (Boolean) - True if the value represents YAML null, false otherwise. #### Response Example * None ``` -------------------------------- ### StreamDocumentRemoved Field Definition Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Model.TrackerEventType.StreamDocumentRemoved Provides the definition, namespace, assembly, and usage example for the StreamDocumentRemoved field. ```APIDOC ## StreamDocumentRemoved Field ### Description Specifies stream Document Removed. ### Namespace SharpYaml.Model ### Assembly SharpYaml.dll ### C# Example ```csharp StreamDocumentRemoved = 1 ``` ### Returns TrackerEventType ``` -------------------------------- ### Initialize YamlReaderWriterBase with Options Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Serialization.YamlReaderWriterBase.-ctor-SharpYaml.YamlSerializerOptions Use this constructor to initialize a YamlReaderWriterBase instance with specific serialization options. The options control how YAML is read or written. ```csharp protected YamlReaderWriterBase(YamlSerializerOptions options) ``` -------------------------------- ### Value Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.Value.-ctor-SharpYaml.Mark-SharpYaml.Mark Initializes a new instance of the Value class. Requires start and end Mark objects. ```csharp public Value(Mark start, Mark end) ``` -------------------------------- ### Initialize YamlWriter with TextWriter and Options Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Serialization.YamlWriter.-ctor-System.IO.TextWriter-SharpYaml.YamlSerializerOptions Initializes a new instance of the YamlWriter class. Use this constructor to specify the TextWriter for output and optional YamlSerializerOptions for formatting. ```csharp public YamlWriter(TextWriter writer, YamlSerializerOptions? options = null) ``` -------------------------------- ### DocumentEnd Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Events.DocumentEnd.-ctor-System.Boolean-SharpYaml.Mark-SharpYaml.Mark Initializes a new instance of the DocumentEnd class within the SharpYaml.Events namespace. ```APIDOC ## DocumentEnd(Boolean, Mark, Mark) Constructor ### Description Initializes a new instance of the DocumentEnd class. ### Parameters - **isImplicit** (Boolean) - Indicates whether the event is implicit. - **start** (Mark) - The start position of the event. - **end** (Mark) - The end position of the event. ### Request Example public DocumentEnd(bool isImplicit, Mark start, Mark end) ``` -------------------------------- ### BlockEntry Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.BlockEntry.-ctor-SharpYaml.Mark-SharpYaml.Mark Initializes a new instance of the BlockEntry class using start and end mark positions. ```APIDOC ## Constructor: BlockEntry(Mark, Mark) ### Description Initializes a new instance of the BlockEntry class. ### Parameters - **start** (Mark) - Required - The start position of the token. - **end** (Mark) - Required - The end position of the token. ### Signature ```csharp public BlockEntry(Mark start, Mark end) ``` ``` -------------------------------- ### Create a YAML reader from a TextReader Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Serialization.YamlReader.Create-System.IO.TextReader-SharpYaml.YamlSerializerOptions Use this method to initialize a YAML reader. The options parameter is optional and controls parsing behaviors. ```csharp public static YamlReader Create(TextReader reader, YamlSerializerOptions? options = null) ``` -------------------------------- ### BlockEnd Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.BlockEnd.-ctor-SharpYaml.Mark-SharpYaml.Mark Initializes a new instance of the BlockEnd class. Requires start and end Mark objects. ```csharp public BlockEnd(Mark start, Mark end) ``` -------------------------------- ### Load Method Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Model.YamlSequence.Load-SharpYaml.EventReader-SharpYaml.Model.YamlNodeTracker Documentation for the static Load method within the SharpYaml.Model namespace. ```APIDOC ## Load(EventReader, YamlNodeTracker?) Method ### Description Loads data from an EventReader into a YamlSequence. ### Method Static Method ### Parameters - **eventReader** (EventReader) - Required - The event reader to load data from. - **tracker** (YamlNodeTracker) - Optional - An optional tracker for YAML nodes. ### Returns - **YamlSequence** - The loaded YAML sequence. ``` -------------------------------- ### StreamStart Class Definition Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Events.StreamStart Details regarding the StreamStart class structure, constructors, properties, and methods. ```APIDOC ## Class: StreamStart ### Description Represents a stream start event in the YAML parsing process. ### Namespace SharpYaml.Events ### Assembly SharpYaml.dll ### Constructors - **StreamStart()**: Initializes a new instance of the StreamStart class. - **StreamStart(Mark, Mark)**: Initializes a new instance of the StreamStart class with specified marks. ### Properties - **NestingIncrease** (int): Gets a value indicating the variation of depth caused by this event. For start events, this value is 1. ### Methods - **ToString()**: Returns a string that represents the current object. ``` -------------------------------- ### Accessing YamlElement via Indexer Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Model.YamlMapping.Item-SharpYaml.Model.YamlElement Use this indexer to get or set a YamlElement at a specific key index. ```csharp public YamlElement? this[YamlElement key] { get; set; } ``` -------------------------------- ### Tag(String, String) Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.Tag.-ctor-System.String-System.String Initializes a new instance of the Tag class using a handle and a suffix. ```APIDOC ## Tag(String, String) Constructor ### Description Initializes a new instance of the Tag class. ### Parameters - **handle** (String) - The handle. - **suffix** (String) - The suffix. ### Request Example ```csharp public Tag(string handle, string suffix) ``` ``` -------------------------------- ### SyntaxErrorException() Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.SyntaxErrorException.-ctor Initializes a new instance of the SyntaxErrorException class. ```APIDOC ## SyntaxErrorException() Constructor ### Description Initializes a new instance of the SyntaxErrorException class. ### Method Constructor ### Endpoint N/A ### Parameters None ### Request Example N/A ### Response N/A ### Error Handling N/A ``` -------------------------------- ### Get Empty Mark - SharpYaml Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Mark.Empty Retrieves a Mark object with empty values. This is a static readonly property. ```csharp public static readonly Mark Empty ``` -------------------------------- ### DocumentEnd Constructor Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.DocumentEnd.-ctor Initializes a new instance of the DocumentEnd class. ```APIDOC ## DocumentEnd() Constructor ### Description Initializes a new instance of the DocumentEnd class. ### Method Constructor ### Endpoint N/A ### Parameters None ### Request Example None ### Response None ### Code Example ```csharp public DocumentEnd() ``` ``` -------------------------------- ### ThrowInvalidGuidScalar Method Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Serialization.YamlThrowHelper.ThrowInvalidGuidScalar-SharpYaml.Serializat-5ab0f58519ca This method is used to throw an exception when an invalid GUID scalar is encountered during YAML parsing. ```APIDOC ## ThrowInvalidGuidScalar(YamlReader) Method ### Description Throws an exception for invalid Scalar. ### Namespace SharpYaml.Serialization ### Assembly SharpYaml.dll ### Method Signature ```csharp public static YamlException ThrowInvalidGuidScalar(YamlReader reader) ``` ### Parameters #### Path Parameters - **reader** (YamlReader) - Required - The YamlReader instance to process. ### Returns - **YamlException** - The exception thrown for an invalid GUID scalar. ``` -------------------------------- ### Initialize VersionDirective Source: https://xoofx.github.io/SharpYaml/api/SharpYaml.Tokens.VersionDirective.-ctor-SharpYaml.Version-SharpYaml.Mark-SharpYaml.Mark Constructor for creating a new VersionDirective instance. ```csharp public VersionDirective(Version version, Mark start, Mark end) ```