API

`#mime/multipart`

import: #mime/multipart

counts: 3 fns, 11 methods, 3 types, 0 consts, 0 ifaces

multipart Reader/Writer. EOF is the error EOF.

`struct Part`

XuAPI

pub struct Part {
    pub keys []string
    pub vals []string
    pub body string
}

Purpose

MIME multipart (RFC 2046 / RFC 2388 form-data) aligned with `mime/multipart` Reader.NextPart + Writer write-field subset. Parts are owning strings (no io.Reader). Headers are parallel slices.

Parameters

keys []string: field ([]string)
vals []string: field ([]string)
body string: body

`struct Reader`

XuAPI

pub struct Reader {
    pub data string
    pub boundary string
    pub pos int
    pub closed int
}

Purpose

Public struct `Reader`.

Parameters

data string: data
boundary string: field (string)
pos int: field (int)
closed int: field (int)

`struct Writer`

XuAPI

pub struct Writer {
    pub boundary string
    pub buf string
    pub started int
    pub closed int
}

Purpose

Public struct `Writer`.

Parameters

boundary string: field (string)
buf string: buffer
started int: field (int)
closed int: field (int)

`(Part) header`

XuAPI

pub fn (p Part) header(name string) string

Purpose

Call `header` on `Part`.

Parameters

p Part: receiver Part (value receiver)
name string: name (string)

Returns

string — result string

`(Part) form_name`

XuAPI

pub fn (p Part) form_name() string

Purpose

Method on `Part`: form name.

Parameters

p Part: receiver Part (value receiver)

Returns

string — result string

`(Part) file_name`

XuAPI

pub fn (p Part) file_name() string

Purpose

Method on `Part`: file name.

Parameters

p Part: receiver Part (value receiver)

Returns

string — result string

`(Part) body`

XuAPI

pub fn (p Part) body() string

Purpose

Call `body` on `Part`.

Parameters

p Part: receiver Part (value receiver)

Returns

string — result string

`new_reader`

XuAPI

pub fn new_reader(body &string, boundary &string) Reader

Purpose

Construct reader.

Parameters

body &string: body (borrowed; caller keeps it; type &string)
boundary &string: boundary (borrowed; caller keeps it; type &string)

Returns

Reader — a value of this type

`(&mut Reader) next_part`

XuAPI

pub fn (r &mut Reader) next_part() Part

Purpose

Method on `&mut Reader`: next part. Throws on failure.

Parameters

r &mut Reader: receiver &mut Reader (exclusive borrow)

Returns

Part — a value of this type

`new_writer`

XuAPI

pub fn new_writer() Writer

Purpose

Construct writer.

Parameters

none

Returns

Writer — a value of this type

`new_writer_with_boundary`

XuAPI

pub fn new_writer_with_boundary(boundary &string) Writer

Purpose

Construct writer with boundary.

Parameters

boundary &string: boundary (borrowed; caller keeps it; type &string)

Returns

Writer — a value of this type

`(Writer) boundary`

XuAPI

pub fn (w Writer) boundary() string

Purpose

Call `boundary` on `Writer`.

Parameters

w Writer: receiver Writer (value receiver)

Returns

string — result string

`(Writer) form_data_content_type`

XuAPI

pub fn (w Writer) form_data_content_type() string

Purpose

Method on `Writer`: form data content type.

Parameters

w Writer: receiver Writer (value receiver)

Returns

string — result string

`(&mut Writer) write_field`

XuAPI

pub fn (w &mut Writer) write_field(name &string, value &string)

Purpose

Method on `&mut Writer`: write field.

Parameters

w &mut Writer: receiver &mut Writer (exclusive borrow)
name &string: name (borrowed; caller keeps it; type &string)
value &string: value (borrowed; caller keeps it; type &string)

`(&mut Writer) write_file`

XuAPI

pub fn (w &mut Writer) write_file(name &string, filename &string, content_type &string, body &string)

Purpose

Method on `&mut Writer`: write file.

Parameters

w &mut Writer: receiver &mut Writer (exclusive borrow)
name &string: name (borrowed; caller keeps it; type &string)
filename &string: filename (borrowed; caller keeps it; type &string)
content_type &string: content_type (borrowed; caller keeps it; type &string)
body &string: body (borrowed; caller keeps it; type &string)

`(&mut Writer) close`

XuAPI

pub fn (w &mut Writer) close()

Purpose

Method on `&mut Writer`: close the resource.

Parameters

w &mut Writer: receiver &mut Writer (exclusive borrow)

`(&Writer) bytes`

XuAPI

pub fn (w &Writer) bytes() string

Purpose

Method on `&Writer`: return the buffered bytes.

Parameters

w &Writer: receiver &Writer (borrow)

Returns

string — result string