|
| 1 | +# Module Documentation |
| 2 | + |
| 3 | +## Module Node.Buffer |
| 4 | + |
| 5 | +### Types |
| 6 | + |
| 7 | + data Buffer :: * |
| 8 | + |
| 9 | + data BufferValueType where |
| 10 | + UInt8 :: BufferValueType |
| 11 | + UInt16LE :: BufferValueType |
| 12 | + UInt16BE :: BufferValueType |
| 13 | + UInt32LE :: BufferValueType |
| 14 | + UInt32BE :: BufferValueType |
| 15 | + Int8 :: BufferValueType |
| 16 | + Int16LE :: BufferValueType |
| 17 | + Int16BE :: BufferValueType |
| 18 | + Int32LE :: BufferValueType |
| 19 | + Int32BE :: BufferValueType |
| 20 | + FloatLE :: BufferValueType |
| 21 | + FloatBE :: BufferValueType |
| 22 | + DoubleLE :: BufferValueType |
| 23 | + DoubleBE :: BufferValueType |
| 24 | + |
| 25 | + data BufferWrite :: ! |
| 26 | + |
| 27 | + type Octet = Number |
| 28 | + |
| 29 | + type Offset = Number |
| 30 | + |
| 31 | + |
| 32 | +### Type Class Instances |
| 33 | + |
| 34 | + instance showBuffer :: Show Buffer |
| 35 | + |
| 36 | + instance showBufferValueType :: Show BufferValueType |
| 37 | + |
| 38 | + |
| 39 | +### Values |
| 40 | + |
| 41 | + concat :: [Buffer] -> Buffer |
| 42 | + |
| 43 | + concat' :: [Buffer] -> Number -> Buffer |
| 44 | + |
| 45 | + copy :: Offset -> Offset -> Buffer -> Offset -> Buffer -> Buffer |
| 46 | + |
| 47 | + create :: Number -> Buffer |
| 48 | + |
| 49 | + fill :: forall e. Octet -> Offset -> Offset -> Buffer -> Eff (buffer :: BufferWrite | e) Unit |
| 50 | + |
| 51 | + fromArray :: [Octet] -> Buffer |
| 52 | + |
| 53 | + fromString :: String -> Encoding -> Buffer |
| 54 | + |
| 55 | + getAtOffset :: Offset -> Buffer -> Maybe Octet |
| 56 | + |
| 57 | + read :: BufferValueType -> Offset -> Buffer -> Number |
| 58 | + |
| 59 | + readString :: forall e. Encoding -> Offset -> Offset -> Buffer -> String |
| 60 | + |
| 61 | + setAtOffset :: forall e. Octet -> Offset -> Buffer -> Eff (buffer :: BufferWrite | e) Unit |
| 62 | + |
| 63 | + size :: forall e. Buffer -> Number |
| 64 | + |
| 65 | + toArray :: Buffer -> [Octet] |
| 66 | + |
| 67 | + toString :: forall e. Encoding -> Buffer -> String |
| 68 | + |
| 69 | + write :: forall e. BufferValueType -> Number -> Offset -> Buffer -> Eff (buffer :: BufferWrite | e) Unit |
| 70 | + |
| 71 | + writeString :: forall e. Encoding -> Offset -> Number -> String -> Buffer -> Eff (buffer :: BufferWrite | e) Number |
| 72 | + |
| 73 | + |
| 74 | +## Module Node.Buffer.Unsafe |
| 75 | + |
| 76 | +### Values |
| 77 | + |
| 78 | + slice :: Offset -> Offset -> Buffer -> Buffer |
| 79 | + |
| 80 | + |
| 81 | +## Module Node.Encoding |
| 82 | + |
| 83 | +### Types |
| 84 | + |
| 85 | + data Encoding where |
| 86 | + ASCII :: Encoding |
| 87 | + UTF8 :: Encoding |
| 88 | + UTF16LE :: Encoding |
| 89 | + UCS2 :: Encoding |
| 90 | + Base64 :: Encoding |
| 91 | + Binary :: Encoding |
| 92 | + Hex :: Encoding |
| 93 | + |
| 94 | + |
| 95 | +### Type Class Instances |
| 96 | + |
| 97 | + instance showEncoding :: Show Encoding |
| 98 | + |
| 99 | + |
| 100 | +### Values |
| 101 | + |
| 102 | + byteLength :: String -> Encoding -> Number |
0 commit comments