HTTP::FormData::Builder

class HTTP::FormData::Builder

• HTTP::FormData::Builder
• Reference
• Object

Overview

Builds a multipart/form-data message.

Example

io = IO::Memory.new
builder = HTTP::FormData::Builder.new(io, "aA47")
builder.field("name", "joe")
file = IO::Memory.new "file contents"
builder.file("upload", io, FileMetadata.new(filename: "test.txt"))
builder.finish
io.to_s # => "--aA47\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\njoe\r\n--aA47\r\nContent-Disposition: form-data; name=\"upload\"; filename=\"test.txt\"\r\n\r\nfile contents\r\n--aA47--"

Defined in:

Class Method Summary

• .new(io : IO, boundary = Multipart.generate_boundary)

  Creates a new FormData::Builder which writes to io, using the multipart boundary boundary-

Instance Method Summary

• #boundary : String
• #content_type

  Returns a content type header with correct boundary parameter.

• #field(name, value, headers : HTTP::Headers = HTTP::Headers.new)

  Adds a form part with the given name and value.

• #file(name, io, metadata : FileMetadata = FileMetadata.new, headers : HTTP::Headers = HTTP::Headers.new)

  Adds a form part called name, with data from io as the value.

• #finish

  Finalizes the multipart message, this method must be called before the generated multipart message written to the IO is considered valid.

Class Method Detail

Instance Method Detail

builder = HTTP::FormData::Builder.new(io, "a4VF")
builder.content_type # => "multipart/form-data; boundary=\"a4VF\""