Struct yukikaze::client::request::multipart::Form

pub struct Form {
    pub boundary: &'static str,
    // some fields omitted
}

Multipart Form.

Default boundary is yuki.

Fields

boundary: &'static str

Boundary to use.

Implementations

impl Form

pub fn new() -> Self

Creates new instance of form.

pub fn with_boundary(boundary: &'static str) -> Self

Creates new instance with provided boundary.

Panic

In debug builds, it asserts whether string contains only ASCII characters or not.

pub fn add_field(&mut self, name: String, data: &[u8])

Adds new field with jsut name.

pub fn add_file_field(
    &mut self,
    field_name: String,
    file_name: String,
    mime: &Mime,
    data: &[u8]
)

Adds new field with file.

pub fn add_file<P: AsRef<Path>>(
    &mut self,
    field_name: String,
    path: P
) -> Result<()>

Adds file to the form.

Note

It reads entire file into buffer.

IO Error

If error happens file copying content of file, then content of storage shall be restored to its state before starting the operation.

pub fn finish(self) -> (u64, Bytes)

Finishes creating form and produces body with its length