The Binary data type value class
Test whether this data type is compatible with valueType. Compatibility
with a valueType means than any valid binary representation of a
value can be read as an
instance of valueType.
Every data type should be compatible with the following:
Value Type – the class corresponding to the data type's value
type.For a data type with a value type of X, readAs(X, buffer) is
equivalent to readValue(buffer).
the type to check
true if a binary representation created by this data
type can read as an instance * of valueType
Obtain a DeltaType by name or delta type.
Example:
// Get by name
var deltas = datatype.deltaType("binary");Example:
// Get by type
var deltas = datatype.deltaType(delta);the name, as returned by DeltaType.name
the delta type
The external type identifier.
the name of this datatype
Create a value of a compatible class from binary.
the type of the result
the binary data
the offset to start reading from the provided buffer (default = 0)
the length of the data to read (default = input.length)
the value in the form of the specified type
Parse a value from binary.
the binary data
the offset to start reading from the provided buffer (default = 0)
the length of the data to read (default = input.length)
an instance of this data type value
Serialise a value to binary
the value to serialise. For primitive and JSON datatypes
the value can be undefined or null. In this case a
null value will be serialised.
the serialised value as a buffer
Serialise a value to binary
the value to serialise. For primitive and JSON datatypes
the value can be undefined or null. In this case a
null value will be serialised.
the serialised value as a buffer
Binary data type.
Accessed via:
diffusion.datatypes.binary();The implementation provides support for binary deltas.
Binary values can be used to store and transmit arbitrary information. The responsibility for formatting and interpreting the information belongs solely to the application. Before using Binary for a topic, consider other data types such as JSON or single value topic types; these may provide a simpler interface for your application.
The implementation provides support for binary deltas.
Binary values are created by passing a
Uint8Arrayobject to BinaryDataType.from. When running the Diffusion Client in a browser context, access to theUint8Arrayapi is made available through diffusion.buffer.5.7