CborReader.TryReadByteString(Span<Byte>, Int32) Method

Definition

Namespace:

System.Formats.Cbor

Assembly:

System.Formats.Cbor.dll

Package:

System.Formats.Cbor v9.0.0-preview.4.24266.19

Source:

CborReader.String.cs

Reads the next data item as a byte string (major type 2).

public:
 bool TryReadByteString(Span<System::Byte> destination, [Runtime::InteropServices::Out] int % bytesWritten);

public bool TryReadByteString (Span<byte> destination, out int bytesWritten);

member this.TryReadByteString : Span<byte> * int -> bool

Public Function TryReadByteString (destination As Span(Of Byte), ByRef bytesWritten As Integer) As Boolean

Parameters

destination

Span<Byte>

The buffer in which to write the read bytes.

bytesWritten

Int32

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

Returns

Boolean

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

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.