@@ -30,13 +30,13 @@ An instance of Node's Buffer class.
30
30
instance showBuffer :: Show Buffer
31
31
```
32
32
33
- #### ` BufferWrite `
33
+ #### ` BUFFER `
34
34
35
35
``` purescript
36
- data BufferWrite :: !
36
+ data BUFFER :: !
37
37
```
38
38
39
- Effect for buffer modification .
39
+ Effect for buffer creation, reading, or writing .
40
40
41
41
#### ` BufferValueType `
42
42
@@ -68,23 +68,23 @@ instance showBufferValueType :: Show BufferValueType
68
68
#### ` create `
69
69
70
70
``` purescript
71
- create :: Int -> Buffer
71
+ create :: forall e. Int -> Eff (buffer :: BUFFER | e) Buffer
72
72
```
73
73
74
74
Creates a new buffer of the specified size.
75
75
76
76
#### ` fromArray `
77
77
78
78
``` purescript
79
- fromArray :: Array Octet -> Buffer
79
+ fromArray :: forall e. Array Octet -> Eff (buffer :: BUFFER | e) Buffer
80
80
```
81
81
82
82
Creates a new buffer from an array of octets, sized to match the array.
83
83
84
84
#### ` fromString `
85
85
86
86
``` purescript
87
- fromString :: String -> Encoding -> Buffer
87
+ fromString :: forall e. String -> Encoding -> Eff (buffer :: BUFFER | e) Buffer
88
88
```
89
89
90
90
Creates a new buffer from a string with the specified encoding, sized to
@@ -93,39 +93,39 @@ match the string.
93
93
#### ` read `
94
94
95
95
``` purescript
96
- read :: BufferValueType -> Offset -> Buffer -> Int
96
+ read :: forall e. BufferValueType -> Offset -> Buffer -> Eff (buffer :: BUFFER | e) Int
97
97
```
98
98
99
99
Reads a numeric value from a buffer at the specified offset.
100
100
101
101
#### ` readString `
102
102
103
103
``` purescript
104
- readString :: Encoding -> Offset -> Offset -> Buffer -> String
104
+ readString :: forall e. Encoding -> Offset -> Offset -> Buffer -> Eff (buffer :: BUFFER | e) String
105
105
```
106
106
107
107
Reads a section of a buffer as a string with the specified encoding.
108
108
109
109
#### ` toString `
110
110
111
111
``` purescript
112
- toString :: Encoding -> Buffer -> String
112
+ toString :: forall e. Encoding -> Buffer -> Eff (buffer :: BUFFER | e) String
113
113
```
114
114
115
115
Reads the buffer as a string with the specified encoding.
116
116
117
117
#### ` write `
118
118
119
119
``` 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
121
121
```
122
122
123
123
Writes a numeric value to a buffer at the specified offset.
124
124
125
125
#### ` writeString `
126
126
127
127
``` 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
129
129
```
130
130
131
131
Writes 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.
135
135
#### ` toArray `
136
136
137
137
``` purescript
138
- toArray :: Buffer -> Array Octet
138
+ toArray :: forall e. Buffer -> Eff (buffer :: BUFFER | e) ( Array Octet)
139
139
```
140
140
141
141
Creates an array of octets from a buffer's contents.
142
142
143
143
#### ` getAtOffset `
144
144
145
145
``` purescript
146
- getAtOffset :: Offset -> Buffer -> Maybe Octet
146
+ getAtOffset :: forall e. Offset -> Buffer -> Eff (buffer :: BUFFER | e) ( Maybe Octet)
147
147
```
148
148
149
149
Reads an octet from a buffer at the specified offset.
150
150
151
151
#### ` setAtOffset `
152
152
153
153
``` 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
155
155
```
156
156
157
157
Writes an octet in the buffer at the specified offset.
158
158
159
159
#### ` size `
160
160
161
161
``` purescript
162
- size :: Buffer -> Int
162
+ size :: forall e. Buffer -> Eff (buffer :: BUFFER | e) Int
163
163
```
164
164
165
165
Returns the size of a buffer.
166
166
167
167
#### ` concat `
168
168
169
169
``` purescript
170
- concat :: Array Buffer -> Buffer
170
+ concat :: forall e. Array Buffer -> Eff (buffer :: BUFFER | e) Buffer
171
171
```
172
172
173
173
Concatenates a list of buffers.
174
174
175
175
#### ` concat' `
176
176
177
177
``` purescript
178
- concat' :: Array Buffer -> Int -> Buffer
178
+ concat' :: forall e. Array Buffer -> Int -> Eff (buffer :: BUFFER | e) Buffer
179
179
```
180
180
181
181
Concatenates a list of buffers, combining them into a new buffer of the
@@ -184,16 +184,16 @@ specified length.
184
184
#### ` copy `
185
185
186
186
``` purescript
187
- copy :: Offset -> Offset -> Buffer -> Offset -> Buffer -> Buffer
187
+ copy :: forall e. Offset -> Offset -> Buffer -> Offset -> Buffer -> Eff (buffer :: BUFFER | e) Int
188
188
```
189
189
190
190
Copies a section of a source buffer into a target buffer at the specified
191
- offset.
191
+ offset, and returns the number of octets copied .
192
192
193
193
#### ` fill `
194
194
195
195
``` 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
197
197
```
198
198
199
199
Fills a range in a buffer with the specified octet.
0 commit comments