CborReader Class

Definition

Namespace:

System.Formats.Cbor

Assembly:

System.Formats.Cbor.dll

Package:

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

Source:

CborReader.cs

A stateful, forward-only reader for Concise Binary Object Representation (CBOR) encoded data.

public ref class CborReader

public class CborReader

type CborReader = class

Public Class CborReader

Inheritance

Object

CborReader

Constructors

CborReader(ReadOnlyMemory<Byte>, CborConformanceMode, Boolean)

Initializes a CborReader instance over the specified data with the given configuration.

Properties

AllowMultipleRootLevelValues	Gets a value that indicates whether this reader allows multiple root-level CBOR data items.
BytesRemaining	Gets the total number of unread bytes in the buffer.
ConformanceMode	Gets the conformance mode used by this reader.
CurrentDepth	Gets the reader's current level of nestedness in the CBOR document.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
PeekState()	Reads the next CBOR token, without advancing the reader.
PeekTag()	Reads the next data item as a semantic tag (major type 6), without advancing the reader.
ReadBigInteger()	Reads the next data item as a tagged bignum encoding, as described in RFC7049 section 2.4.2.
ReadBoolean()	Reads the next data item as a boolean value (major type 7).
ReadByteString()	Reads the next data item as a byte string (major type 2).
ReadCborNegativeIntegerRepresentation()	Reads the next data item as a CBOR negative integer representation (major type 1).
ReadDateTimeOffset()	Reads the next data item as a tagged date/time string, as described in RFC7049 section 2.4.1.
ReadDecimal()	Reads the next data item as a tagged decimal fraction encoding, as described in RFC7049 section 2.4.3.
ReadDefiniteLengthByteString()	Reads the next data item as a definite-length byte string (major type 2).
ReadDefiniteLengthTextStringBytes()	Reads the next data item as a definite-length UTF-8 text string (major type 3).
ReadDouble()	Reads the next data item as a double-precision floating point number (major type 7).
ReadEncodedValue(Boolean)	Reads the next CBOR data item, returning a ReadOnlyMemory<T> view of the encoded value. For indefinite length encodings this includes the break byte.
ReadEndArray()	Reads the end of an array (major type 4).
ReadEndIndefiniteLengthByteString()	Ends reading an indefinite-length byte string (major type 2).
ReadEndIndefiniteLengthTextString()	Ends reading an indefinite-length UTF-8 text string (major type 3).
ReadEndMap()	Reads the end of a map (major type 5).
ReadHalf()	Reads the next data item as a half-precision floating point number (major type 7).
ReadInt32()	Reads the next data item as a signed integer (major types 0,1)
ReadInt64()	Reads the next data item as a signed integer (major types 0,1)
ReadNull()	Reads the next data item as a null value (major type 7).
ReadSimpleValue()	Reads the next data item as a CBOR simple value (major type 7).
ReadSingle()	Reads the next data item as a single-precision floating point number (major type 7).
ReadStartArray()	Reads the next data item as the start of an array (major type 4).
ReadStartIndefiniteLengthByteString()	Reads the next data item as the start of an indefinite-length byte string (major type 2).
ReadStartIndefiniteLengthTextString()	Reads the next data item as the start of an indefinite-length UTF-8 text string (major type 3).
ReadStartMap()	Reads the next data item as the start of a map (major type 5).
ReadTag()	Reads the next data item as a semantic tag (major type 6).
ReadTextString()	Reads the next data item as a UTF-8 text string (major type 3).
ReadUInt32()	Reads the next data item as an unsigned integer (major type 0).
ReadUInt64()	Reads the next data item as an unsigned integer (major type 0).
ReadUnixTimeSeconds()	Reads the next data item as a tagged unix time in seconds, as described in RFC7049 section 2.4.1.
Reset(ReadOnlyMemory<Byte>)	Resets the CborReader instance over the specified data with unchanged configuration. ConformanceMode and AllowMultipleRootLevelValues are unchanged.
SkipToParent(Boolean)	Reads the remaining contents of the current value context, discarding results and advancing the reader to the next value in the parent context.
SkipValue(Boolean)	Reads the contents of the next value, discarding the result and advancing the reader.
ToString()	Returns a string that represents the current object. (Inherited from Object)
TryReadByteString(Span<Byte>, Int32)	Reads the next data item as a byte string (major type 2).
TryReadTextString(Span<Char>, Int32)	Reads the next data item as a UTF-8 text string (major type 3).