gossamer - v9.2.0

gossamer/int16_array

Types

Int16Array

</>

A typed array of 16-bit signed integers.

See Int16Array on MDN.

pub type Int16Array

Values

at

</> 
pub fn at(
  array: Int16Array,
  index index: Int,
) -> Result(Int, Nil)

Returns the element at index, or Error(Nil) if the index is out of range. Negative indices count from the end.

buffer

</> 
pub fn buffer(of array: Int16Array) -> array_buffer.ArrayBuffer

byte_length

</> 
pub fn byte_length(of array: Int16Array) -> Int

byte_offset

</> 
pub fn byte_offset(of array: Int16Array) -> Int

fill

</> 
pub fn fill(array: Int16Array, with value: Int) -> Int16Array

from_buffer

</> 
pub fn from_buffer(
  buffer: array_buffer.ArrayBuffer,
) -> Result(Int16Array, js_error.JsError)

Creates an Int16Array view over buffer. Returns an error if buffer.byteLength is not a multiple of 2 (the element size).

from_buffer_range

</> 
pub fn from_buffer_range(
  buffer: array_buffer.ArrayBuffer,
  byte_offset byte_offset: Int,
  length length: Int,
) -> Result(Int16Array, js_error.JsError)

Creates an Int16Array view over a slice of buffer starting at byte_offset and spanning length elements. Returns an error if the range is out of bounds, buffer is detached, or byte_offset is not a multiple of 2.

from_length

</> 
pub fn from_length(
  length: Int,
) -> Result(Int16Array, js_error.JsError)

Creates a zero-filled Int16Array of the given length. Returns an error if length is negative or exceeds the maximum allocatable size.

from_list

</> 
pub fn from_list(list: List(Int)) -> Int16Array

Creates an Int16Array from a list of 16-bit signed integers. Values outside -32_768–32_767 are wrapped modulo 65_536, matching the JS Int16Array constructor.

includes

</> 
pub fn includes(in array: Int16Array, value value: Int) -> Bool

index_of

</> 
pub fn index_of(
  in array: Int16Array,
  value value: Int,
) -> Result(Int, Nil)

Returns the first index of value, or Error(Nil) if not present.

last_index_of

</> 
pub fn last_index_of(
  in array: Int16Array,
  value value: Int,
) -> Result(Int, Nil)

Returns the last index of value, or Error(Nil) if not present.

length

</> 
pub fn length(of array: Int16Array) -> Int

new

</> 
pub fn new() -> Int16Array

reverse

</> 
pub fn reverse(array: Int16Array) -> Int16Array

set

</> 
pub fn set(
  in array: Int16Array,
  values values: Int16Array,
) -> Result(Nil, js_error.JsError)

Copies values into array starting at index 0. Returns an error if values would extend past the end of array.

set_with_offset

</> 
pub fn set_with_offset(
  in array: Int16Array,
  values values: Int16Array,
  offset offset: Int,
) -> Result(Nil, js_error.JsError)

Copies values into array starting at offset. Returns an error if offset is negative or the copy would extend past the end of array.

slice

</> 
pub fn slice(array: Int16Array) -> Int16Array

slice_range

</> 
pub fn slice_range(
  array: Int16Array,
  from start: Int,
  to end: Int,
) -> Int16Array

subarray

</> 
pub fn subarray(
  array: Int16Array,
  from begin: Int,
  to end: Int,
) -> Int16Array

to_list

</> 
pub fn to_list(array: Int16Array) -> List(Int)

with

</> 
pub fn with(
  array: Int16Array,
  at_index index: Int,
  value value: Int,
) -> Result(Int16Array, js_error.JsError)

Returns a copy of array with the value at index replaced. Negative indices count from the end. Returns an error if index is out of range.

✨ Search Document