Struct form_data::Field

pub struct Field<T> {
    pub length: usize,
    pub index: usize,
    pub name: String,
    pub filename: Option<String>,
    pub content_type: Option<Mime>,
    pub headers: Option<HeaderMap>,
    // some fields omitted
}

Field

Fields

length: usize

The payload size of Field.

index: usize

The index of Field.

name: String

The name of Field.

filename: Option<String>

The filename of Field, optinal.

content_type: Option<Mime>

The content_type of Field, optinal.

headers: Option<HeaderMap>

The extras headers of Field, optinal.

Implementations

impl<T> Field<T>

pub fn empty() -> Self

Creates an empty field.

pub fn headers_mut(&mut self) -> &mut Option<HeaderMap>

Gets mutable headers.

pub fn state_mut(&mut self) -> &mut Option<Arc<Mutex<State<T>>>>

Gets mutable state.

pub fn consumed(&self) -> bool

Gets the status of state.

pub async fn bytes<E>(&mut self) -> Result<Bytes> where
    T: Stream<Item = Result<Bytes, E>> + Unpin,
    E: Into<Error>, 

Reads field data to bytes.

pub async fn copy_to<E, W>(&mut self, writer: &mut W) -> Result<u64> where
    T: Stream<Item = Result<Bytes, E>> + Unpin,
    E: Into<Error>,
    W: AsyncWrite + Send + Unpin + 'static, 

Copys large buffer to AsyncRead, hyper can support large buffer, 8KB <= buffer <= 512KB, so if we want to handle large buffer. Form::set_max_buf_size(512 * 1024); 3~4x performance improvement over the 8KB limitation of AsyncRead.

pub async fn copy_to_file<E>(&mut self, file: File) -> Result<u64> where
    T: Stream<Item = Result<Bytes, E>> + Unpin,
    E: Into<Error>, 

Copys large buffer to File, hyper can support large buffer, 8KB <= buffer <= 512KB, so if we want to handle large buffer. Form::set_max_buf_size(512 * 1024); 4x+ performance improvement over the 8KB limitation of AsyncRead.

pub async fn ignore<E>(&mut self) -> Result<()> where
    T: Stream<Item = Result<Bytes, E>> + Unpin,
    E: Into<Error>, 

Ignores current field data, pass it.

Trait Implementations

impl<T, E> AsyncRead for Field<T> where
    T: Stream<Item = Result<Bytes, E>> + Unpin,
    E: Into<Error>, 

Reads payload data from part, then puts them to anywhere

fn poll_read(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    buf: &mut [u8]
) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &mut [IoSliceMut<'_>]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl<T> Debug for Field<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T, E> Stream for Field<T> where
    T: Stream<Item = Result<Bytes, E>> + Unpin,
    E: Into<Error>, 

Reads payload data from part, then yields them

type Item = Result<Bytes>

Values yielded by the stream.

fn poll_next(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.