Class SBuffer

No-op Serializable implementation that serializes to / from Buffers.

Hierarchy (view full)

SerializableWrapper<Buffer>
- SBuffer
  - SDynamicBuffer

Index

Constructors

Properties

Methods

assignJSON deserialize getSerializedLength serialize toJSON from of

Constructors

constructor

new SBuffer(): SBuffer
Returns SBuffer
Inherited from SerializableWrapper.constructor

Properties

value

value: Buffer = ...

Methods

assignJSON

assignJSON(jsonValue): void
Parameters
- jsonValue: number[] | Buffer | {
  data: number[];
  type: "Buffer";
  }
Returns void
Overrides SerializableWrapper.assignJSON
- Defined in src/serializable-buffers.ts:22

deserialize

deserialize(buffer): number
Deserializes a buffer into this value.
Parameters
- buffer: Buffer
Returns number
Number of bytes read.
Overrides SerializableWrapper.deserialize
- Defined in src/serializable-buffers.ts:8

getSerializedLength

getSerializedLength(): number
Computes the serialized length of this value.

Returns number
Overrides SerializableWrapper.getSerializedLength
- Defined in src/serializable-buffers.ts:18

serialize

serialize(): Buffer
Serializes this value into a buffer.

Returns Buffer
Overrides SerializableWrapper.serialize
- Defined in src/serializable-buffers.ts:14

toJSON

toJSON(): any
Returns any
Inherited from SerializableWrapper.toJSON
- Defined in src/serializable-wrapper.ts:8

`Static` from

from<T>(this, buffer, opts?): T
Creates a new instance of this value by deserializing from a buffer.
Type Parameters
- T extends Serializable
Parameters
- this: (new () => T)
  - - new (): T
    - Returns T
- buffer: Buffer
- Optional opts: DeserializeOptions
Returns T
Inherited from SerializableWrapper.from
- Defined in src/serializable.ts:37

`Static` of

of<ValueT, WrapperT>(this, value): WrapperT
Create a new instance of this wrapper class from a raw value.
Type Parameters
- ValueT
- WrapperT extends SerializableWrapper<ValueT>
Parameters
- this: (new () => WrapperT)
  - - new (): WrapperT
    - Returns WrapperT
- value: ValueT
Returns WrapperT
Inherited from SerializableWrapper.of
- Defined in src/serializable-wrapper.ts:17