gossamer - v9.2.0

gossamer/uint8_clamped_array

Types

Uint8ClampedArray

</>

A typed array of 8-bit unsigned integers, clamped to 0–255 on write (rather than wrapped). Useful for image pixel data where values should saturate at the boundaries.

See Uint8ClampedArray on MDN.

pub type Uint8ClampedArray

Values

at

</> 
pub fn at(
  array: Uint8ClampedArray,
  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: Uint8ClampedArray,
) -> array_buffer.ArrayBuffer

byte_length

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

byte_offset

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

fill

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

from_buffer

</> 
pub fn from_buffer(
  buffer: array_buffer.ArrayBuffer,
) -> Uint8ClampedArray

from_buffer_range

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

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

from_length

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

Creates a zero-filled Uint8ClampedArray 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)) -> Uint8ClampedArray

Creates a Uint8ClampedArray from a list of byte values. Values outside 0–255 are clamped to that range (negative values become 0, values above 255 become 255), unlike Uint8Array which wraps modulo 256.

includes

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

index_of

</> 
pub fn index_of(
  in array: Uint8ClampedArray,
  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: Uint8ClampedArray,
  value value: Int,
) -> Result(Int, Nil)

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

length

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

new

</> 
pub fn new() -> Uint8ClampedArray

reverse

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

set

</> 
pub fn set(
  in array: Uint8ClampedArray,
  values values: Uint8ClampedArray,
) -> 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: Uint8ClampedArray,
  values values: Uint8ClampedArray,
  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: Uint8ClampedArray) -> Uint8ClampedArray

slice_range

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

subarray

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

to_list

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

with

</> 
pub fn with(
  array: Uint8ClampedArray,
  at_index index: Int,
  value value: Int,
) -> Result(Uint8ClampedArray, 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