@@ -30,13 +30,13 @@ An instance of Node's Buffer class.
3030instance showBuffer :: Show Buffer
3131```
3232
33- #### ` BufferWrite `
33+ #### ` BUFFER `
3434
3535``` purescript
36- data BufferWrite :: !
36+ data BUFFER :: !
3737```
3838
39- Effect for buffer modification .
39+ Effect for buffer creation, reading, or writing .
4040
4141#### ` BufferValueType `
4242
@@ -68,23 +68,23 @@ instance showBufferValueType :: Show BufferValueType
6868#### ` create `
6969
7070``` purescript
71- create :: Int -> Buffer
71+ create :: forall e. Int -> Eff (buffer :: BUFFER | e) Buffer
7272```
7373
7474Creates a new buffer of the specified size.
7575
7676#### ` fromArray `
7777
7878``` purescript
79- fromArray :: Array Octet -> Buffer
79+ fromArray :: forall e. Array Octet -> Eff (buffer :: BUFFER | e) Buffer
8080```
8181
8282Creates a new buffer from an array of octets, sized to match the array.
8383
8484#### ` fromString `
8585
8686``` purescript
87- fromString :: String -> Encoding -> Buffer
87+ fromString :: forall e. String -> Encoding -> Eff (buffer :: BUFFER | e) Buffer
8888```
8989
9090Creates a new buffer from a string with the specified encoding, sized to
@@ -93,39 +93,39 @@ match the string.
9393#### ` read `
9494
9595``` purescript
96- read :: BufferValueType -> Offset -> Buffer -> Int
96+ read :: forall e. BufferValueType -> Offset -> Buffer -> Eff (buffer :: BUFFER | e) Int
9797```
9898
9999Reads a numeric value from a buffer at the specified offset.
100100
101101#### ` readString `
102102
103103``` purescript
104- readString :: Encoding -> Offset -> Offset -> Buffer -> String
104+ readString :: forall e. Encoding -> Offset -> Offset -> Buffer -> Eff (buffer :: BUFFER | e) String
105105```
106106
107107Reads a section of a buffer as a string with the specified encoding.
108108
109109#### ` toString `
110110
111111``` purescript
112- toString :: Encoding -> Buffer -> String
112+ toString :: forall e. Encoding -> Buffer -> Eff (buffer :: BUFFER | e) String
113113```
114114
115115Reads the buffer as a string with the specified encoding.
116116
117117#### ` write `
118118
119119``` purescript
120- write :: forall e. BufferValueType -> Int -> Offset -> Buffer -> Eff (buffer :: BufferWrite | e) Unit
120+ write :: forall e. BufferValueType -> Int -> Offset -> Buffer -> Eff (buffer :: BUFFER | e) Unit
121121```
122122
123123Writes a numeric value to a buffer at the specified offset.
124124
125125#### ` writeString `
126126
127127``` purescript
128- writeString :: forall e. Encoding -> Offset -> Int -> String -> Buffer -> Eff (buffer :: BufferWrite | e) Int
128+ writeString :: forall e. Encoding -> Offset -> Int -> String -> Buffer -> Eff (buffer :: BUFFER | e) Int
129129```
130130
131131Writes octets from a string to a buffer at the specified offset. Multi-byte
@@ -135,47 +135,47 @@ to write them fully. The number of bytes written is returned.
135135#### ` toArray `
136136
137137``` purescript
138- toArray :: Buffer -> Array Octet
138+ toArray :: forall e. Buffer -> Eff (buffer :: BUFFER | e) ( Array Octet)
139139```
140140
141141Creates an array of octets from a buffer's contents.
142142
143143#### ` getAtOffset `
144144
145145``` purescript
146- getAtOffset :: Offset -> Buffer -> Maybe Octet
146+ getAtOffset :: forall e. Offset -> Buffer -> Eff (buffer :: BUFFER | e) ( Maybe Octet)
147147```
148148
149149Reads an octet from a buffer at the specified offset.
150150
151151#### ` setAtOffset `
152152
153153``` purescript
154- setAtOffset :: forall e. Octet -> Offset -> Buffer -> Eff (buffer :: BufferWrite | e) Unit
154+ setAtOffset :: forall e. Octet -> Offset -> Buffer -> Eff (buffer :: BUFFER | e) Unit
155155```
156156
157157Writes an octet in the buffer at the specified offset.
158158
159159#### ` size `
160160
161161``` purescript
162- size :: Buffer -> Int
162+ size :: forall e. Buffer -> Eff (buffer :: BUFFER | e) Int
163163```
164164
165165Returns the size of a buffer.
166166
167167#### ` concat `
168168
169169``` purescript
170- concat :: Array Buffer -> Buffer
170+ concat :: forall e. Array Buffer -> Eff (buffer :: BUFFER | e) Buffer
171171```
172172
173173Concatenates a list of buffers.
174174
175175#### ` concat' `
176176
177177``` purescript
178- concat' :: Array Buffer -> Int -> Buffer
178+ concat' :: forall e. Array Buffer -> Int -> Eff (buffer :: BUFFER | e) Buffer
179179```
180180
181181Concatenates a list of buffers, combining them into a new buffer of the
@@ -184,16 +184,16 @@ specified length.
184184#### ` copy `
185185
186186``` purescript
187- copy :: Offset -> Offset -> Buffer -> Offset -> Buffer -> Buffer
187+ copy :: forall e. Offset -> Offset -> Buffer -> Offset -> Buffer -> Eff (buffer :: BUFFER | e) Int
188188```
189189
190190Copies a section of a source buffer into a target buffer at the specified
191- offset.
191+ offset, and returns the number of octets copied .
192192
193193#### ` fill `
194194
195195``` purescript
196- fill :: forall e. Octet -> Offset -> Offset -> Buffer -> Eff (buffer :: BufferWrite | e) Unit
196+ fill :: forall e. Octet -> Offset -> Offset -> Buffer -> Eff (buffer :: BUFFER | e) Unit
197197```
198198
199199Fills a range in a buffer with the specified octet.
0 commit comments