Class SStringNT

Serializable wrapper class for null-terminated strings.

Hierarchy (view full)

SerializableWrapper<string>
- SStringNT

Index

Constructors

Properties

Methods

assignJSON deserialize getSerializedLength serialize toJSON from of ofLength

Constructors

constructor

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

Properties

`Optional` `Readonly` length

length?: number

Fixed serialized size, or undefined if dynamically sized.

value

value: string = ''

Methods

assignJSON

assignJSON<JsonValueT>(jsonValue): void
Type Parameters
- JsonValueT extends string
Parameters
- jsonValue: JsonValueT
Returns void
Inherited from SerializableWrapper.assignJSON
- Defined in src/serializable-wrapper.ts:12

deserialize

deserialize(buffer, opts?): number
Deserializes a buffer into this value.
Parameters
- buffer: Buffer
- Optional opts: DeserializeOptions
Returns number
Number of bytes read.
Overrides SerializableWrapper.deserialize
- Defined in src/serializable-strings.ts:12

getSerializedLength

getSerializedLength(opts?): number
Computes the serialized length of this value.
Parameters
- Optional opts: SerializeOptions
Returns number
Overrides SerializableWrapper.getSerializedLength
- Defined in src/serializable-strings.ts:40

serialize

serialize(opts?): Buffer
Serializes this value into a buffer.
Parameters
- Optional opts: SerializeOptions
Returns Buffer
Overrides SerializableWrapper.serialize
- Defined in src/serializable-strings.ts:27

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

`Static` ofLength

ofLength(length): typeof __class
Returns a SStringNT class that has a fixed serialized size.
Parameters
- length: number
Returns typeof __class
- Defined in src/serializable-strings.ts:45