CborReader.TryReadTextString(Span<Char>, Int32) Method

Definition

Namespace:

System.Formats.Cbor

Assembly:

System.Formats.Cbor.dll

Package:

System.Formats.Cbor v9.0.0-rc.2.24473.5

Source:

CborReader.String.cs

Reads the next data item as a UTF-8 text string (major type 3).

public:
 bool TryReadTextString(Span<char> destination, [Runtime::InteropServices::Out] int % charsWritten);

public bool TryReadTextString (Span<char> destination, out int charsWritten);

member this.TryReadTextString : Span<char> * int -> bool

Public Function TryReadTextString (destination As Span(Of Char), ByRef charsWritten As Integer) As Boolean

Parameters

destination

Span<Char>

The buffer in which to write.

charsWritten

Int32

On success, receives the number of chars written to destination.

Returns

Boolean

true and advances the reader if destination had sufficient length to receive the value, otherwise false and the reader does not advance.

Exceptions

InvalidOperationException

The next data item does not have the correct major type.

CborContentException

The next value has an invalid CBOR encoding.

-or-

There was an unexpected end of CBOR encoding data.

-or-

The next value uses a CBOR encoding that is not valid under the current conformance mode.

Remarks

The method accepts indefinite length strings, which it will concatenate to a single string.