Class lbuffer

Buffer object used with I/O API.

Remarks

The indices parameters are all zero based with TypeScript API.

Indexable

[index: number]: number
byte access (get/set) by index.

Index

Constructors

Properties

Methods

char charCodeAt clear cmp copy insert move remove repeat set setlen swap toLowerCase tostring toUpperCase

Constructors

constructor

new lbuffer(capOrValue?: string | number | lbuffer): lbuffer
Create an lbuffer object.
Parameters
- OptionalcapOrValue: string | number | lbuffer
  Capacity, or a value to copy.
Returns lbuffer

Properties

length

length: number

Get the length.

See

Methods

char

char(...args: number[]): lbuffer
Parameters
- ...args: number[]
Returns lbuffer
self.

charCodeAt

charCodeAt(index: number): number
Get byte value by index.
Parameters
- index: number
  Zero based index.
Returns number

clear

clear(pos?: number, end?: number): lbuffer
Clears part of the buffer.
Parameters
- Optionalpos: number
- Optionalend: number
Returns lbuffer

cmp

cmp(s: string | lbuffer): number
Compares against another value.
Parameters
- s: string | lbuffer
  The value to compare.
Returns number
A number indicating this value and another compare to each other:
- A negative value if this value comes before another;
- A positive value if this value after another;
- 0 if they are considered equal.

copy

copy(pos?: number, end?: number): lbuffer
Copy part of the buffer into a new buffer.
Parameters
- Optionalpos: number
  Start position, inclusive.
- Optionalend: number
  End poisiton, exclusive.
Returns lbuffer
A new lbuffer.

Remarks
Length is end - pos;

insert

insert(
    index: number,
    value: string | lbuffer,
    pos?: number,
    end?: number,
): lbuffer
Insert into the current lbuffer.
Parameters
- index: number
  Position to insert from.
- value: string | lbuffer
  Value to insert.
- Optionalpos: number
  Start position of the value, inclusive.
- Optionalend: number
  End position of the value, exclusive.
Returns lbuffer
Self

move

move(dst: number, pos: number, end?: number): lbuffer
Move part of buffer to a new position.
Parameters
- dst: number
  Destination position.
- pos: number
  Start position, inclusive.
- Optionalend: number
  end position, exclusive.
Returns lbuffer

remove

remove(pos?: number, end?: number): lbuffer
Removes part of the buffer.
Parameters
- Optionalpos: number
  Start position, inclusive.
- Optionalend: number
  End poisiton, exclusive.
Returns lbuffer
Remarks
Length is end - pos;

repeat

repeat(count: number): lbuffer
Parameters
- count: number
Returns lbuffer

set

set(index: number, value: string | lbuffer, pos?: number, end?: number): lbuffer
Set the value of the buffer.
Parameters
- index: number
  Starting index.
- value: string | lbuffer
  The source.
- Optionalpos: number
  Start position, inclusive.
- Optionalend: number
  End poisiton, exclusive.
Returns lbuffer
Self.

Remarks
Length is end - pos;

setlen

setlen(v: number): lbuffer
Set the length of the buffer.
Parameters
- v: number
Returns lbuffer
self.

swap

swap(p1: number, e1: number, p2: number, e2?: number): lbuffer
Swap between two slices.
Parameters
- p1: number
  Position of part 1, inclusive.
- e1: number
  End of part 1, exclusive.
- p2: number
  Position of part 2, inclusive.
- Optionale2: number
  End of part 2, exclusive.
Returns lbuffer

toLowerCase

toLowerCase(): lbuffer
Convert to lower case.

Returns lbuffer

tostring

tostring(pos?: number, len?: number): string
Convert part of the buffer into a lua string.
Parameters
- Optionalpos: number
  Position
- Optionallen: number
  Length
Returns string
The resulting string.

toUpperCase

toUpperCase(): lbuffer
Convert to upper case.

Returns lbuffer