Class CBORType

The CBOR type.

Inheritance

System.Object

CBORType

Namespace: PushTechnology.ClientInterface.IO.CBOR

Assembly: Diffusion.Client.dll

Syntax

public sealed class CBORType : object

Fields

ARRAY_END

Represents the end of a CBOR array structure type.

Declaration

public static readonly CBORType ARRAY_END

Field Value

Type	Description
CBORType	The end of a CBOR array structure type.

ARRAY_START

Represents the start of a CBOR array structure type.

Declaration

public static readonly CBORType ARRAY_START

Field Value

Type	Description
CBORType	The start of a CBOR array structure type.

BYTE_SEQUENCE

Represents the CBOR byte sequence type.

Declaration

public static readonly CBORType BYTE_SEQUENCE

Field Value

Type	Description
CBORType	The CBOR byte sequence type.

FIELD_NAME

Represents the CBOR UTF-8 encoded field name type.

Declaration

public static readonly CBORType FIELD_NAME

Field Value

Type	Description
CBORType	The CBOR UTF-8 encoded field name type.

OBJECT_END

Represents the end of a CBOR object structure type.

Declaration

public static readonly CBORType OBJECT_END

Field Value

Type	Description
CBORType	The end of a CBOR object structure type.

OBJECT_START

Represents the start of a CBOR object structure type.

Declaration

public static readonly CBORType OBJECT_START

Field Value

Type	Description
CBORType	The start of a CBOR object structure type.

VALUE_FALSE

Represents the CBOR boolean value type that is set to false.

Declaration

public static readonly CBORType VALUE_FALSE

Field Value

Type	Description
CBORType	The false CBOR boolean value type.

VALUE_FLOAT

Represents the CBOR floating point value type.

Declaration

public static readonly CBORType VALUE_FLOAT

Field Value

Type	Description
CBORType	The CBOR floating point value type.

VALUE_INTEGER

Represents the CBOR integer value type.

Declaration

public static readonly CBORType VALUE_INTEGER

Field Value

Type	Description
CBORType	The CBOR integer value type.

VALUE_NULL

Represents the CBOR 'null' value type.

Declaration

public static readonly CBORType VALUE_NULL

Field Value

Type	Description
CBORType	The CBOR 'null' value type.

VALUE_STRING

Represents the CBOR UTF-8 encoded string type.

Declaration

public static readonly CBORType VALUE_STRING

Field Value

Type	Description
CBORType	The CBOR UTF-8 encoded string type.

VALUE_TRUE

Represents the CBOR boolean value that is set to true.

Declaration

public static readonly CBORType VALUE_TRUE

Field Value

Type	Description
CBORType	The true CBOR boolean value type.

Properties

IsBoolean

Returns true if the current CBOR type is a boolean value. Otherwise false.

Declaration

public bool IsBoolean { get; }

Property Value

Type	Description
System.Boolean	Whether the current CBOR type is a boolean value.

Remarks

The boolean value will either be true or false. It will never be represented as an integer or string value.

IsNumeric

Returns true if the current CBOR type is a numeric type. Otherwise false.

Declaration

public bool IsNumeric { get; }

Property Value

Type	Description
System.Boolean	Whether the current CBOR type is a numeric type.

Remarks

A numeric type can either be a integer or floating point.

IsSequence

Returns true if the current CBOR type is a sequence of bytes. Otherwise false.

Declaration

public bool IsSequence { get; }

Property Value

Type	Description
System.Boolean	Whether the current CBOR type is a sequence of bytes.

Remarks

A sequence of bytes could either be a UTF-8 encoded field name, a UTF-8 encoded string or a simple sequence of bytes with no predetermined encoding.

IsStructureEnd

Returns true if the current CBOR type indicates the end of a structure. Otherwise false.

Declaration

public bool IsStructureEnd { get; }

Property Value

Type	Description
System.Boolean	Whether the current CBOR type indicates the end of a structure.

Remarks

A structure could either be a simple sequence of values or a sequence of key/value pairs, where the key is a UTF-8 encoded field name.

IsStructureStart

Returns true if the current CBOR type indicates the start of a structure. Otherwise false.

Declaration

public bool IsStructureStart { get; }

Property Value

Type	Description
System.Boolean	Whether the current CBOR type indicates the start of a structure.

Remarks

A structure could either be a simple sequence of values or a sequence of key/value pairs, where the key is a UTF-8 encoded field name.