buffer

#node:buffer

Buffer type for binary data manipulation

#Installation

Add to your moon.pkg.json:

{
  "import": [
    "mizchi/js",
    "mizchi/js_node/buffer"
  ]
}

#Buffer Creation

Buffer::from_string(str, encoding?) - Create from string
Buffer::from_array(arr) - Create from byte array
Buffer::from_arraybuffer(ab, byteOffset?, length?) - Create from ArrayBuffer
Buffer::from_buffer(buf) - Copy from another buffer
Buffer::alloc(size, fill?, encoding?) - Allocate zero-filled buffer
Buffer::allocUnsafe(size) - Allocate uninitialized buffer (faster)

#Static Methods

Buffer::isBuffer(obj) - Check if object is a Buffer
Buffer::isEncoding(encoding) - Check if encoding is valid
Buffer::compare(buf1, buf2) - Compare two buffers
Buffer::concat(buffers, totalLength?) - Concatenate buffers
Buffer::byteLength(str, encoding?) - Get byte length of string

#Instance Methods

#Read Methods

#Write Methods

#Iteration

entries() - Get iterator of [index, byte] pairs
keys() - Get iterator of indices
values() - Get iterator of byte values

#External Types

ArrayBuffer - JavaScript ArrayBuffer type

Buffer

source

#external
pub type Buffer

Buffer::alloc

source

fn Buffer::alloc(size : Int, fill? : @mizchi/js_core.Any
Any, encoding? : String) -> Buffer

Allocate a new zero-filled buffer

Buffer::allocUnsafe

source

#alias(alloc_unsafe)
fn Buffer::allocUnsafe(size : Int) -> Buffer

Allocate an uninitialized buffer (faster but potentially insecure)

Buffer::as_any

source

fn Buffer::as_any(self : Buffer) -> @mizchi/js_core.Any
Any

Buffer::buffer

source

fn Buffer::buffer(self : Buffer) -> @mizchi/js_builtin/arraybuffer.ArrayBuffer
ArrayBuffer

Get the underlying ArrayBuffer

Buffer::byteLength

source

#alias(byte_length)
fn Buffer::byteLength(str : String, encoding? : String) -> Int

Get the byte length of a string when encoded

Buffer::byteOffset

source

#alias(byte_offset)
fn Buffer::byteOffset(self : Buffer) -> Int

Get the byte offset in the underlying ArrayBuffer

Buffer::compare

source

fn Buffer::compare(buf1 : Buffer, buf2 : Buffer) -> Int

Compare two buffers

Buffer::compare_with

source

fn Buffer::compare_with(self : Buffer, target : Buffer, target_start? : Int, target_end? : Int, source_start? : Int, source_end? : Int) -> Int

Compare this buffer with another buffer

Buffer::concat

source

fn Buffer::concat(list : Array[Buffer], total_length? : Int) -> Buffer

Concatenate an array of buffers

Buffer::copy

source

fn Buffer::copy(self : Buffer, target : Buffer, target_start? : Int, source_start? : Int, source_end? : Int) -> Int

Copy data from this buffer to a target buffer

Buffer::equals

source

fn Buffer::equals(self : Buffer, other : Buffer) -> Bool

Test if this buffer equals another buffer

Buffer::fill

source

fn Buffer::fill(self : Buffer, value : @mizchi/js_core.Any
Any, offset? : Int, end? : Int, encoding? : String) -> Buffer

Fill the buffer with a value

Buffer::from_array

source

fn Buffer::from_array(arr : Array[Int]) -> Buffer

Create a Buffer from an array of bytes

Buffer::from_arraybuffer

source

fn Buffer::from_arraybuffer(ab : @mizchi/js_builtin/arraybuffer.ArrayBuffer
ArrayBuffer, byte_offset? : Int, length? : Int) -> Buffer

Create a Buffer from an ArrayBuffer

Buffer::from_buffer

source

fn Buffer::from_buffer(buf : Buffer) -> Buffer

Create a Buffer by copying another buffer

Buffer::from_string

source

fn Buffer::from_string(str : String, encoding? : String) -> Buffer

Create a Buffer from a string with optional encoding

Buffer::includes

source

fn Buffer::includes(self : Buffer, value : @mizchi/js_core.Any
Any, byte_offset? : Int, encoding? : String) -> Bool

Check if the buffer includes a value

Buffer::indexOf

source

#alias(index_of)
fn Buffer::indexOf(self : Buffer, value : @mizchi/js_core.Any
Any, byte_offset? : Int, encoding? : String) -> Int

Find the index of a value in the buffer

Buffer::isBuffer

source

#alias(is_buffer)
fn Buffer::isBuffer(obj : @mizchi/js_core.Any
Any) -> Bool

Check if an object is a Buffer

Buffer::isEncoding

source

#alias(is_encoding)
fn Buffer::isEncoding(encoding : String) -> Bool

Check if a string is a valid encoding

Buffer::lastIndexOf

source

#alias(last_index_of)
fn Buffer::lastIndexOf(self : Buffer, value : @mizchi/js_core.Any
Any, byte_offset? : Int, encoding? : String) -> Int

Find the last index of a value in the buffer

Buffer::length

source

fn Buffer::length(self : Buffer) -> Int

Get the length of the buffer in bytes

Buffer::slice

source

fn Buffer::slice(self : Buffer, start? : Int, end? : Int) -> Buffer

Create a view of a portion of the buffer

Buffer::subarray

source

fn Buffer::subarray(self : Buffer, start? : Int, end? : Int) -> Buffer

Create a subarray (TypedArray-compatible view)

Buffer::toJSON

source

#alias(to_json)
fn Buffer::toJSON(self : Buffer) -> BufferJSON

Convert buffer to JSON representation

Buffer::toString

source

#alias(to_string)
fn Buffer::toString(self : Buffer, encoding? : String, start? : Int, end? : Int) -> String

Convert buffer to string with optional encoding and range

Buffer::write

source

fn Buffer::write(self : Buffer, str : String, offset? : Int, length? : Int, encoding? : String) -> Int

Write a string to the buffer

BufferJSON

source

#external
pub type BufferJSON

BufferJSON - Result of Buffer.toJSON() Contains the type string "Buffer" and the data as an array of bytes

BufferJSON::as_any

source

fn BufferJSON::as_any(self : BufferJSON) -> @mizchi/js_core.Any
Any

BufferJSON::data

source

fn BufferJSON::data(self : BufferJSON) -> Array[Int]

Get the data as an array of bytes

BufferJSON::type_

source

fn BufferJSON::type_(self : BufferJSON) -> String

Get the type field (always "Buffer")

Source Files

buffer.mbt

#mizchi/js_node/buffer

#node:buffer

#Installation

#Buffer Creation

#Static Methods

#Instance Methods

#Read Methods

#Write Methods

#Iteration

#External Types

#Buffer

#Buffer::alloc

#Buffer::allocUnsafe

#Buffer::as_any

#Buffer::buffer

#Buffer::byteLength

#Buffer::byteOffset

#Buffer::compare

#Buffer::compare_with

#Buffer::concat

#Buffer::copy

#Buffer::equals

#Buffer::fill

#Buffer::from_array

#Buffer::from_arraybuffer

#Buffer::from_buffer

#Buffer::from_string

#Buffer::includes

#Buffer::indexOf

#Buffer::isBuffer

#Buffer::isEncoding

#Buffer::lastIndexOf

#Buffer::length

#Buffer::slice

#Buffer::subarray

#Buffer::toJSON

#Buffer::toString

#Buffer::write

#BufferJSON

#BufferJSON::as_any

#BufferJSON::data

#BufferJSON::type_

Source Files

Buffer

Buffer::alloc

Buffer::allocUnsafe

Buffer::as_any

Buffer::buffer

Buffer::byteLength

Buffer::byteOffset

Buffer::compare

Buffer::compare_with

Buffer::concat

Buffer::copy

Buffer::equals

Buffer::fill

Buffer::from_array

Buffer::from_arraybuffer

Buffer::from_buffer

Buffer::from_string

Buffer::includes

Buffer::indexOf

Buffer::isBuffer

Buffer::isEncoding

Buffer::lastIndexOf

Buffer::length

Buffer::slice

Buffer::subarray

Buffer::toJSON

Buffer::toString

Buffer::write

BufferJSON

BufferJSON::as_any

BufferJSON::data

BufferJSON::type_