class HTTP::FormData::Builder


Builds a multipart/form-data message.


io =
builder =, "aA47")
builder.field("name", "joe")
file = "file contents"
builder.file("upload", io, "test.txt"))
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

Instance Method Summary

Instance methods inherited from class Reference

==(other : self)
, dup dup, hash hash, inspect(io : IO) : Nil inspect, object_id : UInt64 object_id, pretty_print(pp) : Nil pretty_print, same?(other : Reference)
same?(other : Nil)
, to_s(io : IO) : Nil to_s

Class methods inherited from class Reference

new new

Instance methods inherited from class Object

!=(other) !=, !~(other) !~, ==(other) ==, ===(other : JSON::Any)
===(other : YAML::Any)
, =~(other) =~, class class, dup dup, hash hash, inspect(io : IO)
, itself itself, not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, tap(&block) tap, to_json(io : IO)
, to_pretty_json(indent : String = " ")
to_pretty_json(io : IO, indent : String = " ")
, to_s
to_s(io : IO)
, to_yaml(io : IO)
, try(&block) try

Class methods inherited from class Object

from_json(string_or_io, root : String) : self
from_json(string_or_io) : self
, from_yaml(string_or_io) : self from_yaml

Class Method Detail

def : IO, boundary = Multipart.generate_boundary) #

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

[View source]

Instance Method Detail

def boundary : String #

[View source]
def content_type #

Returns a content type header with correct boundary parameter.

builder =, "a4VF")
builder.content_type # => "multipart/form-data; boundary=\"a4VF\""

[View source]
def field(name, value, headers : HTTP::Headers = #

Adds a form part with the given name and value. Headers can optionally be provided for the form part.

[View source]
def file(name, io, metadata : FileMetadata =, headers : HTTP::Headers = #

Adds a form part called name, with data from io as the value. Metadata can be provided to add extra metadata about the file to the Content-Disposition header for the form part. Other headers can be added using headers.

[View source]
def finish #

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

[View source]