README
¶
multiform
A Reader based interface to easily stream multipart/form-data encoded data.
Install
go get github.com/wyattis/multiform
Usage
The builder interface is analogous to the multipart.Writer interface in the standard lib, but much simpler to use. Most of the code to encode the form is copied verbatim from the standard package.
Simple example
file, _ := os.Open("large-file.zip")
form := multiform.NewBuilder()
form.AddField("key", "value")
form.AddFormFile("file", file)
form.Done()
res, err := http.Post("example.com", form.FormDataContentType(), form)
Custom boundary
Custom boundary can be called anytime before the form is read.
form := multiform.NewBuilder()
form.SetBoundary("custom-boundary")
form.AddFormFile("file", file)
form.Done()
res, err := http.Post("example.com", form.FormDataContentType(), form)
Documentation
¶
Index ¶
- type FormBuilder
- func (f *FormBuilder) AddField(fieldName string, fieldValue string)
- func (f *FormBuilder) AddFormField(fieldName string, body io.Reader)
- func (f *FormBuilder) AddFormFile(fieldName string, fileName string, body io.ReadCloser)
- func (f *FormBuilder) AddPart(header textproto.MIMEHeader, body io.Reader)
- func (f FormBuilder) Close() (err error)
- func (f *FormBuilder) Done()
- func (f *FormBuilder) FormDataContentType() string
- func (f FormBuilder) Read(b []byte) (int, error)
- func (f *FormBuilder) SetBoundary(boundary string) error
- type FormBuilderPart
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type FormBuilder ¶
type FormBuilder struct {
Parts []FormBuilderPart
// contains filtered or unexported fields
}
func NewBuilder ¶
func NewBuilder() FormBuilder
func (*FormBuilder) AddField ¶
func (f *FormBuilder) AddField(fieldName string, fieldValue string)
func (*FormBuilder) AddFormField ¶
func (f *FormBuilder) AddFormField(fieldName string, body io.Reader)
func (*FormBuilder) AddFormFile ¶
func (f *FormBuilder) AddFormFile(fieldName string, fileName string, body io.ReadCloser)
func (*FormBuilder) AddPart ¶
func (f *FormBuilder) AddPart(header textproto.MIMEHeader, body io.Reader)
func (FormBuilder) Close ¶
func (f FormBuilder) Close() (err error)
func (*FormBuilder) Done ¶
func (f *FormBuilder) Done()
func (*FormBuilder) FormDataContentType ¶
func (f *FormBuilder) FormDataContentType() string
func (*FormBuilder) SetBoundary ¶
func (f *FormBuilder) SetBoundary(boundary string) error
type FormBuilderPart ¶
type FormBuilderPart struct {
Header textproto.MIMEHeader
Body io.Reader
}
Source Files
Click to show internal directories.
Click to hide internal directories.