Struct form_data::Field

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

Fields

name: String

index: Option<usize>

filename: Option<String>

content_type: Option<Mime>

headers: Option<HeaderMap>

length: u64

Implementations

impl<T> Field<T>

pub fn empty() -> Self

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

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

pub fn state(&self) -> Result<MutexGuard<State<T>>>

pub fn consumed(&self) -> bool

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

Reads field data to bytes

pub async fn copy_to<'_, O, E, W>(
    __arg0: Self,
    writer: &'_ mut W
) -> Result<u64> where
    T: Stream<Item = Result<O, E>> + Unpin + Send + 'static,
    O: Into<Bytes>,
    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<O, E>(__arg0: Self, __arg1: File) -> Result<u64> where
    T: Stream<Item = Result<O, E>> + Unpin + Send + 'static,
    O: Into<Bytes>,
    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<O, E>(__arg0: Self) -> Result<()> where
    T: Stream<Item = Result<O, E>> + Unpin + Send + 'static,
    O: Into<Bytes>,
    E: Into<Error>, 

Ignores current field data, pass it

Trait Implementations

impl<T, O, E> AsyncRead for Field<T> where
    T: Stream<Item = Result<O, E>> + Unpin + Send + 'static,
    O: Into<Bytes>,
    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, O, E> Stream for Field<T> where
    T: Stream<Item = Result<O, E>> + Unpin + Send + 'static,
    O: Into<Bytes>,
    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.