HTTP::FormData::Builder
class HTTP::FormData::Builder
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:
http/formdata/builder.crClass 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.
Instance methods inherited from class Reference
==(other : self)==(other) ==, 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) same?, 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) ===, =~(other) =~, class class, dup dup, hash hash, inspect(io : IO)
inspect inspect, 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_json to_json, to_pretty_json(indent : String = " ")
to_pretty_json(io : IO, indent : String = " ") to_pretty_json, to_s
to_s(io : IO) to_s, to_yaml(io : IO)
to_yaml to_yaml, try(&block) try
Class methods inherited from class Object
from_json(string_or_io, root : String) : selffrom_json(string_or_io) : self from_json, from_yaml(string_or_io) : self from_yaml
Class Method Detail
def self.new(io : IO, boundary = Multipart.generate_boundary)Source
Creates a new FormData::Builder
which writes to io, using the multipart boundary boundary-
Instance Method Detail
def content_typeSource
Returns a content type header with correct boundary parameter.
builder = HTTP::FormData::Builder.new(io, "a4VF") builder.content_type # => "multipart/form-data; boundary=\"a4VF\""
def field(name, value, headers : HTTP::Headers = HTTP::Headers.new)Source
Adds a form part with the given name and value. Headers can optionally be provided for the form part.
def file(name, io, metadata : FileMetadata = FileMetadata.new, headers : HTTP::Headers = HTTP::Headers.new)Source
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.
def finishSource
Finalizes the multipart message, this method must be called before the generated multipart message written to the IO is considered valid.
© 2012–2017 Manas Technology Solutions.
Licensed under the Apache License, Version 2.0.
https://crystal-lang.org/api/0.22.0/HTTP/FormData/Builder.html