Class SBuffer

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

Hierarchy (View Summary)

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:
        | number[]
        | Buffer<ArrayBufferLike>
        | { data: number[]; type: "Buffer" },
): void
Parameters
- jsonValue: number[] | Buffer<ArrayBufferLike> | { data: number[]; type: "Buffer" }
Returns void
Overrides SerializableWrapper.assignJSON
- Defined in src/serializable-buffers.ts:22

deserialize

deserialize(buffer: 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<ArrayBufferLike>
Serializes this value into a buffer.

Returns Buffer<ArrayBufferLike>
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:9

`Static`from

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

`Static`of

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