Module

Node.Buffer

Mutable buffers and associated operations.

#Buffer​

data Buffer

A reference to a mutable buffer for use with Effect

Instances

#create​

create :: Int -> Effect Buffer

Creates a new buffer of the specified size. Alias to alloc.

#alloc​

alloc :: Int -> Effect Buffer

Creates a new buffer of the specified size.

#allocUnsafe​

allocUnsafe :: Int -> Effect Buffer

Creates a new buffer of the specified size. Unsafe because it reuses memory from a pool and may contain sensitive data. See the Node docs: https://nodejs.org/docs/latest-v18.x/api/buffer.html#what-makes-bufferallocunsafe-and-bufferallocunsafeslow-unsafe

#allocUnsafeSlow​

allocUnsafeSlow :: Int -> Effect Buffer

Creates a new buffer of the specified size. Unsafe because it reuses memory from a pool and may contain sensitive data. See the Node docs: https://nodejs.org/docs/latest-v18.x/api/buffer.html#what-makes-bufferallocunsafe-and-bufferallocunsafeslow-unsafe

#compareParts​

compareParts :: Buffer -> Buffer -> Offset -> Offset -> Offset -> Offset -> Effect Ordering

#fromArray​

fromArray :: Array Octet -> Effect Buffer

#fromString​

fromString :: String -> Encoding -> Effect Buffer

#fromArrayBuffer​

fromArrayBuffer :: ArrayBuffer -> Effect Buffer

#toArrayBuffer​

toArrayBuffer :: Buffer -> Effect ArrayBuffer

#readString​

readString :: Encoding -> Offset -> Offset -> Buffer -> Effect String

#toString​

toString :: Encoding -> Buffer -> Effect String

#toString'​

toString' :: Encoding -> Offset -> Offset -> Buffer -> Effect String

#writeString​

writeString :: Encoding -> Offset -> Int -> String -> Buffer -> Effect Int

#toArray​

toArray :: Buffer -> Effect (Array Octet)

#getAtOffset​

getAtOffset :: Offset -> Buffer -> Effect (Maybe Octet)

#setAtOffset​

setAtOffset :: Octet -> Offset -> Buffer -> Effect Unit

#slice​

slice :: Offset -> Offset -> Buffer -> Buffer

#size​

size :: Buffer -> Effect Int

#concat'​

concat' :: Array Buffer -> Int -> Effect Buffer

#copy​

copy :: Offset -> Offset -> Buffer -> Offset -> Buffer -> Effect Int

#fill​

fill :: Octet -> Offset -> Offset -> Buffer -> Effect Unit

#poolSize​

poolSize :: Effect (Int)

The size (in bytes) of pre-allocated internal Buffer instances used for pooling. This value may be modified.

#setPoolSize​

setPoolSize :: Int -> Effect Unit

#swap16​

swap16 :: Buffer -> Effect Buffer

#swap32​

swap32 :: Buffer -> Effect Buffer

#swap64​

swap64 :: Buffer -> Effect Buffer

Re-exports from Node.Buffer.Types

#Offset​

type Offset = Int

Type synonym indicating the value refers to an offset in a buffer.

#Octet​

type Octet = Int

Type synonym indicating the value should be an octet (0-255). If the value provided is outside this range it will be used as modulo 256.

#BufferValueType​

data BufferValueType

Enumeration of the numeric types that can be written to a buffer.

Constructors

Instances

Modules