Skip to content

Commit 48318fa

Browse files
lpillpil
committed
Bodies are bit strings
1 parent 2aabb88 commit 48318fa

File tree

3 files changed

+41
-39
lines changed

3 files changed

+41
-39
lines changed

‎CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Changelog
22

3+
## v3.5.0 - 2023-08-04
4+
5+
- The `parse_multipart_body` function now return a bit string rather than a string.
6+
37
## v3.4.0 - 2023-08-02
48

59
- The `gleam/http` module gains the `parse_multipart_headers`,

‎src/gleam/http.gleam

+10-14
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ pub type MultipartBody {
132132
// The rest of the body for this part. The full body of the part is this
133133
// concatenated onto the end of each chunk returned by any previous
134134
// `MoreRequiredForBody` returns.
135-
chunk: String,
135+
chunk: BitString,
136136
/// This is `True` if this was the last part in the multipart message,
137137
/// otherwise there are more parts to parse.
138138
done: Bool,
@@ -145,7 +145,7 @@ pub type MultipartBody {
145145
// The body that has been parsed so far. The full body of the part is this
146146
// concatenated with the chunk returned by each `MoreRequiredForBody` return
147147
// value, and the final `MultipartBody` return value.
148-
chunk: String,
148+
chunk: BitString,
149149
/// Call this function to continue parsing the body for this part.
150150
continuation: fn(BitString) -> Result(MultipartBody, Nil),
151151
)
@@ -207,7 +207,7 @@ fn parse_body_with_bit_string(
207207
let bsize = bit_string.byte_size(boundary)
208208
let prefix = bit_string.slice(data, 0, 2 + bsize)
209209
case prefix == Ok(<<45, 45, boundary:bit_string>>) {
210-
True -> Ok(MultipartBody("", done: False, remaining: data))
210+
True -> Ok(MultipartBody(<<>>, done: False, remaining: data))
211211
False -> parse_body_loop(data, boundary, <<>>)
212212
}
213213
}
@@ -222,8 +222,7 @@ fn parse_body_loop(
222222
let required = 6 + bsize
223223
case data {
224224
_ if dsize < required -> {
225-
use chunk <- result.try(bit_string.to_string(body))
226-
more_please_body(parse_body_loop(_, boundary, <<>>), chunk, data)
225+
more_please_body(parse_body_loop(_, boundary, <<>>), body, data)
227226
}
228227

229228
// TODO: flatten this into a single case expression once JavaScript supports
@@ -238,16 +237,13 @@ fn parse_body_loop(
238237
let rest = bit_string.slice(data, size, dsize - size)
239238
case prefix == Ok(desired), rest {
240239
// --boundary\r\n
241-
True, Ok(<<13, 10, _:binary>>) -> {
242-
use body <- result.map(bit_string.to_string(body))
243-
MultipartBody(body, done: False, remaining: data)
244-
}
240+
True, Ok(<<13, 10, _:binary>>) ->
241+
Ok(MultipartBody(body, done: False, remaining: data))
245242

246243
// --boundary--
247-
True, Ok(<<45, 45, data:binary>>) -> {
248-
use body <- result.map(bit_string.to_string(body))
249-
MultipartBody(body, done: True, remaining: data)
250-
}
244+
True, Ok(<<45, 45, data:binary>>) ->
245+
Ok(MultipartBody(body, done: True, remaining: data))
246+
251247
False, _ -> parse_body_loop(data, boundary, <<body:bit_string, 13, 10>>)
252248
_, _ -> Error(Nil)
253249
}
@@ -539,7 +535,7 @@ fn parse_rfc_2045_parameter_unquoted_value(
539535

540536
fn more_please_body(
541537
continuation: fn(BitString) -> Result(MultipartBody, Nil),
542-
chunk: String,
538+
chunk: BitString,
543539
existing: BitString,
544540
) -> Result(MultipartBody, Nil) {
545541
fn(more) {

‎test/gleam/http/multipart_test.gleam

+27-25
Original file line numberDiff line numberDiff line change
@@ -111,14 +111,14 @@ This is the body of the next part\r
111111
let assert Ok(MultipartBody(body, False, rest)) = case return {
112112
MoreRequiredForBody(chunk, continue) -> {
113113
let assert Ok(MultipartBody(body, done, remaining)) = continue(after)
114-
Ok(MultipartBody(chunk <> body, done, remaining))
114+
Ok(MultipartBody(bit_string.append(chunk, body), done, remaining))
115115
}
116116
MultipartBody(body, done, remaining) ->
117117
Ok(MultipartBody(body, done, bit_string.append(remaining, after)))
118118
}
119119

120120
body
121-
|> should.equal("This is the body of the message.")
121+
|> should.equal(<<"This is the body of the message.":utf8>>)
122122
rest
123123
|> should.equal(<<
124124
"--frontier\r
@@ -172,7 +172,9 @@ Ym9keSBvZiB0aGUgbWVzc2FnZS48L3A+CiAgPC9ib2R5Pgo8L2h0bWw+Cg==\r
172172
let assert Ok(MultipartBody(body, False, input)) =
173173
http.parse_multipart_body(input, "frontier")
174174
body
175-
|> should.equal("This is a message with multiple parts in MIME format.")
175+
|> should.equal(<<
176+
"This is a message with multiple parts in MIME format.":utf8,
177+
>>)
176178

177179
let assert Ok(MultipartHeaders(headers, input)) =
178180
http.parse_multipart_headers(input, "frontier")
@@ -182,7 +184,7 @@ Ym9keSBvZiB0aGUgbWVzc2FnZS48L3A+CiAgPC9ib2R5Pgo8L2h0bWw+Cg==\r
182184
let assert Ok(MultipartBody(body, False, input)) =
183185
http.parse_multipart_body(input, "frontier")
184186
body
185-
|> should.equal("This is the body of the message.")
187+
|> should.equal(<<"This is the body of the message.":utf8>>)
186188

187189
let assert Ok(MultipartHeaders(headers, input)) =
188190
http.parse_multipart_headers(input, "frontier")
@@ -195,10 +197,10 @@ Ym9keSBvZiB0aGUgbWVzc2FnZS48L3A+CiAgPC9ib2R5Pgo8L2h0bWw+Cg==\r
195197
let assert Ok(MultipartBody(body, True, rest)) =
196198
http.parse_multipart_body(input, "frontier")
197199
body
198-
|> should.equal(
200+
|> should.equal(<<
199201
"PGh0bWw+CiAgPGhlYWQ+CiAgPC9oZWFkPgogIDxib2R5PgogICAgPHA+VGhpcyBpcyB0aGUg\r
200-
Ym9keSBvZiB0aGUgbWVzc2FnZS48L3A+CiAgPC9ib2R5Pgo8L2h0bWw+Cg==",
201-
)
202+
Ym9keSBvZiB0aGUgbWVzc2FnZS48L3A+CiAgPC9ib2R5Pgo8L2h0bWw+Cg==":utf8,
203+
>>)
202204
rest
203205
|> should.equal(<<>>)
204206
}
@@ -236,7 +238,7 @@ Content-Transfer-Encoding: binary\r
236238
let assert Ok(MultipartBody(body, False, input)) =
237239
http.parse_multipart_body(input, "AaB03x")
238240
body
239-
|> should.equal("Larry")
241+
|> should.equal(<<"Larry":utf8>>)
240242

241243
let assert Ok(MultipartHeaders(headers, input)) =
242244
http.parse_multipart_headers(input, "AaB03x")
@@ -250,7 +252,7 @@ Content-Transfer-Encoding: binary\r
250252
let assert Ok(MultipartBody(body, False, input)) =
251253
http.parse_multipart_body(input, "BbC04y")
252254
body
253-
|> should.equal("")
255+
|> should.equal(<<"":utf8>>)
254256

255257
let assert Ok(MultipartHeaders(headers, input)) =
256258
http.parse_multipart_headers(input, "BbC04y")
@@ -263,7 +265,7 @@ Content-Transfer-Encoding: binary\r
263265
let assert Ok(MultipartBody(body, False, input)) =
264266
http.parse_multipart_body(input, "BbC04y")
265267
body
266-
|> should.equal("... contents of file1.txt ...")
268+
|> should.equal(<<"... contents of file1.txt ...":utf8>>)
267269

268270
let assert Ok(MultipartHeaders(headers, input)) =
269271
http.parse_multipart_headers(input, "BbC04y")
@@ -277,12 +279,12 @@ Content-Transfer-Encoding: binary\r
277279
let assert Ok(MultipartBody(body, True, input)) =
278280
http.parse_multipart_body(input, "BbC04y")
279281
body
280-
|> should.equal("...contents of file2.gif...")
282+
|> should.equal(<<"...contents of file2.gif...":utf8>>)
281283

282284
let assert Ok(MultipartBody(body, True, input)) =
283285
http.parse_multipart_body(input, "AaB03x")
284286
body
285-
|> should.equal("")
287+
|> should.equal(<<>>)
286288
input
287289
|> should.equal(<<>>)
288290
}
@@ -301,7 +303,7 @@ This is the epilogue. Here it includes leading CRLF":utf8,
301303
let assert Ok(MultipartBody(body, False, input)) =
302304
http.parse_multipart_body(input, "boundary")
303305
body
304-
|> should.equal("This is the preamble.")
306+
|> should.equal(<<"This is the preamble.":utf8>>)
305307

306308
let assert Ok(MultipartHeaders(headers, input)) =
307309
http.parse_multipart_headers(input, "boundary")
@@ -311,7 +313,7 @@ This is the epilogue. Here it includes leading CRLF":utf8,
311313
let assert Ok(MultipartBody(body, True, input)) =
312314
http.parse_multipart_body(input, "boundary")
313315
body
314-
|> should.equal("This is the body of the message.")
316+
|> should.equal(<<"This is the body of the message.":utf8>>)
315317

316318
input
317319
|> should.equal(<<
@@ -333,7 +335,7 @@ This is the body of the message.\r
333335
let assert Ok(MultipartBody(body, False, input)) =
334336
http.parse_multipart_body(input, "boundary")
335337
body
336-
|> should.equal("This is the preamble.")
338+
|> should.equal(<<"This is the preamble.":utf8>>)
337339

338340
let assert Ok(MultipartHeaders(headers, input)) =
339341
http.parse_multipart_headers(input, "boundary")
@@ -343,7 +345,7 @@ This is the body of the message.\r
343345
let assert Ok(MultipartBody(body, True, input)) =
344346
http.parse_multipart_body(input, "boundary")
345347
body
346-
|> should.equal("This is the body of the message.")
348+
|> should.equal(<<"This is the body of the message.":utf8>>)
347349

348350
input
349351
|> should.equal(<<"\r\n":utf8>>)
@@ -373,12 +375,12 @@ This is the epilogue. It is also to be ignored.":utf8,
373375
let assert Ok(MultipartBody(body, False, input)) =
374376
http.parse_multipart_body(input, "simple boundary")
375377
body
376-
|> should.equal(
378+
|> should.equal(<<
377379
"This is the preamble. It is to be ignored, though it\r
378380
is a handy place for composition agents to include an\r
379381
explanatory note to non-MIME conformant readers.\r
380-
",
381-
)
382+
":utf8,
383+
>>)
382384

383385
let assert Ok(MultipartHeaders(headers, input)) =
384386
http.parse_multipart_headers(input, "simple boundary")
@@ -388,10 +390,10 @@ explanatory note to non-MIME conformant readers.\r
388390
let assert Ok(MultipartBody(body, False, input)) =
389391
http.parse_multipart_body(input, "simple boundary")
390392
body
391-
|> should.equal(
393+
|> should.equal(<<
392394
"This is implicitly typed plain US-ASCII text.\r
393-
It does NOT end with a linebreak.",
394-
)
395+
It does NOT end with a linebreak.":utf8,
396+
>>)
395397

396398
let assert Ok(MultipartHeaders(headers, input)) =
397399
http.parse_multipart_headers(input, "simple boundary")
@@ -401,11 +403,11 @@ It does NOT end with a linebreak.",
401403
let assert Ok(MultipartBody(body, True, input)) =
402404
http.parse_multipart_body(input, "simple boundary")
403405
body
404-
|> should.equal(
406+
|> should.equal(<<
405407
"This is explicitly typed plain US-ASCII text.\r
406408
It DOES end with a linebreak.\r
407-
",
408-
)
409+
":utf8,
410+
>>)
409411

410412
input
411413
|> should.equal(<<

0 commit comments

Comments
 (0)