njs/buffer

Buffer is a view of ArrayBuffer

Types

ArrayBuffer

pub type ArrayBuffer

Buffer

</>

pub type Buffer

BufferConstants

</>

pub type BufferConstants

Byte

</>

Byte is size(8) unit(1) bitarray

pub type Byte =
  BitArray

ByteLength

</>

Valid byte lengths for Buffer readInt/readUInt/writeInt/writeUInt methods.

njs 1.0.0 rejects zero-length reads and writes. Use the _sized helpers below when the width is known statically.

pub type ByteLength {
  One
  Two
  Three
  Four
  Five
  Six
}

Constructors

```
One
```
```
Two
```
```
Three
```
```
Four
```
```
Five
```
```
Six
```

Encoding

</>

pub type Encoding {
  Utf8
  Hex
  Base64
  Base64Url
}

Constructors

```
Utf8
```
```
Hex
```
```
Base64
```
```
Base64Url
```

TypedArray

</>

pub type TypedArray

TypedArrayType

</>

pub type TypedArrayType {
  Int8
  UInt8
  Int16
  UInt16
  Int32
  UInt32
}

Constructors

```
Int8
```
```
UInt8
```
```
Int16
```
```
UInt16
```
```
Int32
```
```
UInt32
```

Values

alloc

</>

pub fn alloc(size s: Int) -> Buffer

alloc_unsafe

</>

pub fn alloc_unsafe(size s: Int) -> Buffer

array_buffer_byte_length

</>

pub fn array_buffer_byte_length(ab: ArrayBuffer) -> Int

byte_length

</>

pub fn byte_length(value v: v, encoding e: Encoding) -> Int

byte_length_to_int

</>

pub fn byte_length_to_int(length: ByteLength) -> Int

compare

</>

pub fn compare(buffer1 b1: Buffer, buffer2 b2: Buffer) -> Int

concat

</>

pub fn concat(
  buffers bs: array.Array(Buffer),
  length t: t,
) -> Buffer

constants

</>

pub fn constants() -> BufferConstants

constants_max_length

</>

pub fn constants_max_length() -> Int

constants_max_string_length

</>

pub fn constants_max_string_length() -> Int

copy

</>

pub fn copy(
  dst bd: Buffer,
  src bs: Buffer,
  from f: Int,
  to t: Int,
) -> Buffer

equals

</>

pub fn equals(buffer1 b1: Buffer, buffer2 b2: Buffer) -> Bool

fill

</>

pub fn fill(
  buffer bf: Buffer,
  with v: BitArray,
  from f: Int,
  to t: Int,
) -> Buffer

from

</>

pub fn from(
  array_buffer ab: ArrayBuffer,
  offset o: Int,
  length l: Int,
) -> Buffer

from_buffer

</>

pub fn from_buffer(buffer bf: Buffer) -> Buffer

from_bytes

</>

pub fn from_bytes(array ab: array.Array(BitArray)) -> Buffer

from_string

</>

pub fn from_string(
  string ba: String,
  encoding e: Encoding,
) -> Buffer

get_buffer

</>

pub fn get_buffer(buffer bf: Buffer) -> ArrayBuffer

get_buffer_offset

</>

pub fn get_buffer_offset(buffer b: Buffer) -> Int

get_byte

</>

pub fn get_byte(buffer bf: Buffer, offset o: Int) -> BitArray

includes

</>

pub fn includes(
  buffer bf: Buffer,
  value v: v,
  offset o: Int,
) -> Bool

includes_string

</>

pub fn includes_string(
  buffer bf: Buffer,
  value v: String,
  offset o: Int,
  encoding e: Encoding,
) -> Bool

index_of

</>

pub fn index_of(
  buffer bf: Buffer,
  value v: v,
  offset o: Int,
) -> Int

index_of_string

</>

pub fn index_of_string(
  buffer bf: Buffer,
  value v: String,
  offset o: Int,
  encoding e: Encoding,
) -> Int

is_buffer

</>

pub fn is_buffer(obj: a) -> Bool

is_encoding

</>

pub fn is_encoding(encoding e: Encoding) -> Bool

last_index_of

</>

pub fn last_index_of(
  buffer bf: Buffer,
  value v: v,
  offset o: Int,
  encoding e: Encoding,
) -> Int

last_index_of_string

</>

pub fn last_index_of_string(
  buffer bf: Buffer,
  value v: String,
  offset o: Int,
  encoding e: Encoding,
) -> Int

length

</>

pub fn length(buffer bf: Buffer) -> Int

new_array_buffer

</>

pub fn new_array_buffer(size s: Int) -> ArrayBuffer

new_typed_array

</>

pub fn new_typed_array(
  t: TypedArrayType,
  size s: Int,
) -> TypedArray

read_double_be

</>

pub fn read_double_be(buffer bf: Buffer, offset o: Int) -> Float

read_double_le

</>

pub fn read_double_le(buffer bf: Buffer, offset o: Int) -> Float

read_float_be

</>

pub fn read_float_be(buffer bf: Buffer, offset o: Int) -> Float

read_float_le

</>

pub fn read_float_le(buffer bf: Buffer, offset o: Int) -> Float

read_int16_be

</>

pub fn read_int16_be(buffer bf: Buffer, offset o: Int) -> Int

read_int16_le

</>

pub fn read_int16_le(buffer bf: Buffer, offset o: Int) -> Int

read_int32_be

</>

pub fn read_int32_be(buffer bf: Buffer, offset o: Int) -> Int

read_int32_le

</>

pub fn read_int32_le(buffer bf: Buffer, offset o: Int) -> Int

read_int8

</>

pub fn read_int8(buffer bf: Buffer, offset o: Int) -> Int

read_int_be

</>

pub fn read_int_be(
  buffer bf: Buffer,
  offset o: Int,
  byte_length l: Int,
) -> Int

read_int_be_sized

</>

pub fn read_int_be_sized(
  buffer bf: Buffer,
  offset o: Int,
  byte_length l: ByteLength,
) -> Int

read_int_le

</>

pub fn read_int_le(
  buffer bf: Buffer,
  offset o: Int,
  byte_length l: Int,
) -> Int

read_int_le_sized

</>

pub fn read_int_le_sized(
  buffer bf: Buffer,
  offset o: Int,
  byte_length l: ByteLength,
) -> Int

read_uint16_be

</>

pub fn read_uint16_be(buffer bf: Buffer, offset o: Int) -> Int

read_uint16_le

</>

pub fn read_uint16_le(buffer bf: Buffer, offset o: Int) -> Int

read_uint32_be

</>

pub fn read_uint32_be(buffer bf: Buffer, offset o: Int) -> Int

read_uint32_le

</>

pub fn read_uint32_le(buffer bf: Buffer, offset o: Int) -> Int

read_uint8

</>

pub fn read_uint8(buffer bf: Buffer, offset o: Int) -> Int

read_uint_be

</>

pub fn read_uint_be(
  buffer bf: Buffer,
  offset o: Int,
  byte_length l: Int,
) -> Int

read_uint_be_sized

</>

pub fn read_uint_be_sized(
  buffer bf: Buffer,
  offset o: Int,
  byte_length l: ByteLength,
) -> Int

read_uint_le

</>

pub fn read_uint_le(
  buffer bf: Buffer,
  offset o: Int,
  byte_length l: Int,
) -> Int

read_uint_le_sized

</>

pub fn read_uint_le_sized(
  buffer bf: Buffer,
  offset o: Int,
  byte_length l: ByteLength,
) -> Int

set_byte

</>

pub fn set_byte(
  buffer bf: Buffer,
  offset o: Int,
  byte b: BitArray,
) -> Buffer

slice

</>

pub fn slice(buffer bf: Buffer, from f: Int, to t: Int) -> Buffer

subarray

</>

pub fn subarray(
  buffer bf: Buffer,
  start s: Int,
  end e: Int,
) -> Buffer

swap16

</>

pub fn swap16(buffer bf: Buffer) -> Buffer

swap32

</>

pub fn swap32(buffer bf: Buffer) -> Buffer

swap64

</>

pub fn swap64(buffer bf: Buffer) -> Buffer

to_json

</>

pub fn to_json(buffer bf: Buffer) -> json.Json

to_string

</>

pub fn to_string(
  buffer bf: Buffer,
  encoding e: Encoding,
  from f: Int,
  to t: Int,
) -> String

write

</>

pub fn write(
  buffer bf: Buffer,
  string ba: String,
  encoding e: Encoding,
  offset o: Int,
  length l: Int,
) -> Buffer

write at offset of buffer for length number of bytes

write_double_be

</>

pub fn write_double_be(
  buffer bf: Buffer,
  value v: Float,
  offset o: Int,
) -> Buffer

write_double_le

</>

pub fn write_double_le(
  buffer bf: Buffer,
  value v: Float,
  offset o: Int,
) -> Buffer

write_float_be

</>

pub fn write_float_be(
  buffer bf: Buffer,
  value v: Float,
  offset o: Int,
) -> Buffer

write_float_le

</>

pub fn write_float_le(
  buffer bf: Buffer,
  value v: Float,
  offset o: Int,
) -> Buffer

write_int16_be

</>

pub fn write_int16_be(
  buffer bf: Buffer,
  value v: Int,
  offset o: Int,
) -> Buffer

write_int16_le

</>

pub fn write_int16_le(
  buffer bf: Buffer,
  value v: Int,
  offset o: Int,
) -> Buffer

write_int32_be

</>

pub fn write_int32_be(
  buffer bf: Buffer,
  value v: Int,
  offset o: Int,
) -> Buffer

write_int32_le

</>

pub fn write_int32_le(
  buffer bf: Buffer,
  value v: Int,
  offset o: Int,
) -> Buffer

write_int8

</>

pub fn write_int8(
  buffer bf: Buffer,
  value v: Int,
  offset o: Int,
) -> Buffer

write_int_be

</>

pub fn write_int_be(
  buffer bf: Buffer,
  value v: Int,
  offset o: Int,
  byte_length l: Int,
) -> Buffer

write_int_be_sized

</>

pub fn write_int_be_sized(
  buffer bf: Buffer,
  value v: Int,
  offset o: Int,
  byte_length l: ByteLength,
) -> Buffer

write_int_le

</>

pub fn write_int_le(
  buffer bf: Buffer,
  value v: Int,
  offset o: Int,
  byte_length l: Int,
) -> Buffer

write_int_le_sized

</>

pub fn write_int_le_sized(
  buffer bf: Buffer,
  value v: Int,
  offset o: Int,
  byte_length l: ByteLength,
) -> Buffer

write_uint16_be

</>

pub fn write_uint16_be(
  buffer bf: Buffer,
  value v: Int,
  offset o: Int,
) -> Buffer

write_uint16_le

</>

pub fn write_uint16_le(
  buffer bf: Buffer,
  value v: Int,
  offset o: Int,
) -> Buffer

write_uint32_be

</>

pub fn write_uint32_be(
  buffer bf: Buffer,
  value v: Int,
  offset o: Int,
) -> Buffer

write_uint32_le

</>

pub fn write_uint32_le(
  buffer bf: Buffer,
  value v: Int,
  offset o: Int,
) -> Buffer

write_uint8

</>

pub fn write_uint8(
  buffer bf: Buffer,
  value v: Int,
  offset o: Int,
) -> Buffer

write_uint_be

</>

pub fn write_uint_be(
  buffer bf: Buffer,
  value v: Int,
  offset o: Int,
  byte_length l: Int,
) -> Buffer

write_uint_be_sized

</>

pub fn write_uint_be_sized(
  buffer bf: Buffer,
  value v: Int,
  offset o: Int,
  byte_length l: ByteLength,
) -> Buffer

write_uint_le

</>

pub fn write_uint_le(
  buffer bf: Buffer,
  value v: Int,
  offset o: Int,
  byte_length l: Int,
) -> Buffer

write_uint_le_sized

</>

pub fn write_uint_le_sized(
  buffer bf: Buffer,
  value v: Int,
  offset o: Int,
  byte_length l: ByteLength,
) -> Buffer