gossamer/array_buffer

Types

ArrayBuffer

A generic raw binary data buffer.

pub type ArrayBuffer

Values

byte_length

</>

pub fn byte_length(of array_buffer: ArrayBuffer) -> Int

is_detached

</>

pub fn is_detached(array_buffer: ArrayBuffer) -> Bool

is_resizable

</>

pub fn is_resizable(array_buffer: ArrayBuffer) -> Bool

is_view

</>

pub fn is_view(value: a) -> Bool

max_byte_length

</>

pub fn max_byte_length(of array_buffer: ArrayBuffer) -> Int

new

</>

pub fn new(
  byte_length: Int,
) -> Result(ArrayBuffer, js_error.JsError)

Creates a fixed-size ArrayBuffer of byte_length bytes. Returns an error if byte_length is negative or exceeds the maximum allocatable size.

new_resizable

</>

pub fn new_resizable(
  byte_length: Int,
  max_byte_length max: Int,
) -> Result(ArrayBuffer, js_error.JsError)

Creates a resizable ArrayBuffer with the given initial byte length and maximum byte length. Returns an error if either is negative or max exceeds the maximum allocatable size.

resize

</>

pub fn resize(
  array_buffer: ArrayBuffer,
  to byte_length: Int,
) -> Result(Nil, js_error.JsError)

Resizes the ArrayBuffer to the specified byte length. The buffer must have been created with new_resizable. Returns an error if the new length exceeds the maximum byte length.

slice

</>

pub fn slice(array_buffer: ArrayBuffer) -> ArrayBuffer

slice_from

</>

pub fn slice_from(
  array_buffer: ArrayBuffer,
  start: Int,
) -> ArrayBuffer

slice_range

</>

pub fn slice_range(
  array_buffer: ArrayBuffer,
  from start: Int,
  to end: Int,
) -> ArrayBuffer

transfer

</>

pub fn transfer(
  array_buffer: ArrayBuffer,
) -> Result(ArrayBuffer, js_error.JsError)

Transfers the buffer’s contents to a new ArrayBuffer, detaching the original. Returns an error if the buffer is already detached.