package multipart
Import Path
mime/multipart (on golang.org and go.dev)
Dependency Relation
imports 13 packages, and imported by one package
Involved Source Files
formdata.go
d-> multipart.go
writer.go
Exported Type Names
type File (interface)
File is an interface to access the file part of a multipart message.
Its contents may be either stored in memory or on disk.
If stored on disk, the File's underlying concrete type will be an *os.File.
( T) Close() error
( T) Read(p []byte) (n int, err error)
( T) ReadAt(p []byte, off int64) (n int, err error)
( T) Seek(offset int64, whence int) (int64, error)
os.(*File)
T : io.Closer
T : io.ReadCloser
T : io.Reader
T : io.ReaderAt
T : io.ReadSeeker
T : io.Seeker
func (*FileHeader).Open() (File, error)
func net/http.(*Request).FormFile(key string) (File, *FileHeader, error)
type FileHeader (struct)
A FileHeader describes a file part of a multipart request.
Filename string
Header textproto.MIMEHeader
Size int64
Open opens and returns the FileHeader's associated File.
func net/http.(*Request).FormFile(key string) (File, *FileHeader, error)
type Form (struct)
Form is a parsed multipart form.
Its File parts are stored either in memory or on disk,
and are accessible via the *FileHeader's Open method.
Its Value parts are stored as strings.
Both are keyed by field name.
File map[string][]*FileHeader
Value map[string][]string
RemoveAll removes any temporary files associated with a Form.
func (*Reader).ReadForm(maxMemory int64) (*Form, error)
type Part (struct)
A Part represents a single part in a multipart body.
The headers of the body, if any, with the keys canonicalized
in the same fashion that the Go http.Request headers are.
For example, "foo-bar" changes case to "Foo-Bar"
(*T) Close() error
FileName returns the filename parameter of the Part's
Content-Disposition header.
FormName returns the name parameter if p has a Content-Disposition
of type "form-data". Otherwise it returns the empty string.
Read reads the body of a part, after its headers and before the
next part (if any) begins.
*T : io.Closer
*T : io.ReadCloser
*T : io.Reader
func (*Reader).NextPart() (*Part, error)
func (*Reader).NextRawPart() (*Part, error)
type Reader (struct)
Reader is an iterator over parts in a MIME multipart body.
Reader's underlying parser consumes its input as needed. Seeking
isn't supported.
NextPart returns the next part in the multipart or an error.
When there are no more parts, the error io.EOF is returned.
As a special case, if the "Content-Transfer-Encoding" header
has a value of "quoted-printable", that header is instead
hidden and the body is transparently decoded during Read calls.
NextRawPart returns the next part in the multipart or an error.
When there are no more parts, the error io.EOF is returned.
Unlike NextPart, it does not have special handling for
"Content-Transfer-Encoding: quoted-printable".
ReadForm parses an entire multipart message whose parts have
a Content-Disposition of "form-data".
It stores up to maxMemory bytes + 10MB (reserved for non-file parts)
in memory. File parts which can't be stored in memory will be stored on
disk in temporary files.
It returns ErrMessageTooLarge if all non-file parts can't be stored in
memory.
func NewReader(r io.Reader, boundary string) *Reader
func net/http.(*Request).MultipartReader() (*Reader, error)
type Writer (struct)
A Writer generates multipart messages.
Boundary returns the Writer's boundary.
Close finishes the multipart message and writes the trailing
boundary end line to the output.
CreateFormField calls CreatePart with a header using the
given field name.
CreateFormFile is a convenience wrapper around CreatePart. It creates
a new form-data header with the provided field name and file name.
CreatePart creates a new multipart section with the provided
header. The body of the part should be written to the returned
Writer. After calling CreatePart, any previous part may no longer
be written to.
FormDataContentType returns the Content-Type for an HTTP
multipart/form-data with this Writer's Boundary.
SetBoundary overrides the Writer's default randomly-generated
boundary separator with an explicit value.
SetBoundary must be called before any parts are created, may only
contain certain ASCII characters, and must be non-empty and
at most 70 bytes long.
WriteField calls CreateFormField and then writes the given value.
*T : io.Closer
func NewWriter(w io.Writer) *Writer
Exported Values
var ErrMessageTooLarge error
ErrMessageTooLarge is returned by ReadForm if the message form
data is too large to be processed.
![]() |
The pages are generated with Golds v0.1.7. (GOOS=linux GOARCH=amd64) Golds is a Go 101 project and developed by Tapir Liu. PR and bug reports are welcome and can be submitted to the issue list. Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds. |