Class BufferVisitor

BufferVisitor is a visit tool to manipulate buffer.

Hierarchy

BufferVisitor

Index

Constructors

constructor

Properties

Accessors

length

Methods

Constructors

constructor

new BufferVisitor(buf: Buffer, start?: number, end?: number): BufferVisitor

- Defined in common.ts:12
Parameters
- buf: Buffer
- Default value start: number = 0
- Default value end: number = 0
Returns BufferVisitor

Properties

buf

buf: Buffer

end

end: number

start

start: number

Accessors

length

get length(): number

- Defined in common.ts:22
return the underlying buffer length

Returns number

Methods

mustHas

mustHas(steps: number, message?: string): this

- Defined in common.ts:57
The buffer should have remaining the "steps" of bytes to consume, otherwise it will throw an error with given message.

Parameters
- steps: number
  
  steps to consume.
- Default value message: string = "Too few bytes to parse."
  
  message to throw.
Returns this

mustWalk

mustWalk(steps: number, message?: undefined | string): this

- Defined in common.ts:74
Check the remaining bytes with bufferVisitor.mustHas method and then walk.

Parameters
- steps: number
  
  steps to consume.
- Optional message: undefined | string
  
  message to throw.
Returns this

reset

reset(start?: number, end?: number): this

- Defined in common.ts:31
Reset visitor' start and end value.

Parameters
- Default value start: number = 0
- Default value end: number = 0
Returns this

walk

walk(steps: number): this

- Defined in common.ts:45
consume some bytes.

Parameters
- steps: number
  
  steps to walk
Returns this

Generated using TypeDoc