Module

Node.Buffer

Package: purescript-node-buffer
Repository: purescript-node/purescript-node-buffer

Mutable buffers and associated operations.

#Buffer Source

data Buffer

A reference to a mutable buffer for use with Effect

Instances

MutableBuffer Buffer Effect

#create Source

create :: Int -> Effect Buffer

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

#alloc Source

alloc :: Int -> Effect Buffer

Creates a new buffer of the specified size.

#allocUnsafe Source

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 Source

allocUnsafeSlow :: Int -> Effect Buffer

#compareParts Source

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

#freeze Source

freeze :: Buffer -> Effect ImmutableBuffer

#unsafeFreeze Source

unsafeFreeze :: Buffer -> Effect ImmutableBuffer

#thaw Source

thaw :: ImmutableBuffer -> Effect Buffer

#unsafeThaw Source

unsafeThaw :: ImmutableBuffer -> Effect Buffer

#fromArray Source

fromArray :: Array Octet -> Effect Buffer

#fromString Source

fromString :: String -> Encoding -> Effect Buffer

#fromArrayBuffer Source

fromArrayBuffer :: ArrayBuffer -> Effect Buffer

#toArrayBuffer Source

toArrayBuffer :: Buffer -> Effect ArrayBuffer

#read Source

read :: BufferValueType -> Offset -> Buffer -> Effect Number

#readString Source

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

#toString Source

toString :: Encoding -> Buffer -> Effect String

#toString' Source

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

#write Source

write :: BufferValueType -> Number -> Offset -> Buffer -> Effect Unit

#writeString Source

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

#toArray Source

toArray :: Buffer -> Effect (Array Octet)

#getAtOffset Source

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

#setAtOffset Source

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

#slice Source

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

#size Source

size :: Buffer -> Effect Int

#concat Source

concat :: Array Buffer -> Effect Buffer

#concat' Source

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

#copy Source

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

#fill Source

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

#poolSize Source

poolSize :: Effect (Int)

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

#setPoolSize Source

setPoolSize :: Int -> Effect Unit

#swap16 Source

swap16 :: Buffer -> Effect Buffer

#swap32 Source

swap32 :: Buffer -> Effect Buffer

#swap64 Source

swap64 :: Buffer -> Effect Buffer

#transcode Source

transcode :: Buffer -> Encoding -> Encoding -> Effect Buffer

Re-exports from Node.Buffer.Types

#Offset Source

type Offset = Int

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

#Octet Source

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 Source

data BufferValueType

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

Constructors

Instances

Show BufferValueType

Modules: Node.Buffer; Node.Buffer.Class; Node.Buffer.Constants; Node.Buffer.Immutable; Node.Buffer.ST; Node.Buffer.Types; Node.Encoding