Enum Progress 

#[non_exhaustive]
pub enum Progress<'d, F> {
    Field {
        name: &'d str,
        value: &'d [u8],
    },
    File(F),
    NeedInput,
    End,
}

Available on crate feature alloc only.

What completed during a Driver::push. Debug shows a field’s name and value length, never the value.

Examples

let body = b"--X\r\nContent-Disposition: form-data; name=a\r\n\r\n1\r\n--X\r\nContent-Disposition: form-data; name=f; filename=a.txt\r\n\r\nhi\r\n--X--";
let (mut pos, mut seen) = (0, Vec::new());
loop {
    let (n, progress) = driver.push(&body[pos..], true, &mut NoInspector)?;
    pos += n;
    match progress {
        Progress::Field { name, value } => seen.push(format!("{name}: {} bytes", value.len())),
        Progress::File(file) => seen.push(format!("file: {} bytes", file.len())),
        _ => break, // End; NeedInput would mean the body was cut short
    }
}
assert_eq!(seen, ["a: 1 bytes", "file: 2 bytes"]);

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Field

A text field ended: its name and value.

Fields

name: &'d str

The field name.

value: &'d [u8]

The value bytes.

File(F)

A file part ended: the sink’s output.

NeedInput

Every byte given was consumed; give more.

End

The form is complete.

Trait Implementations

impl<F> Debug for Progress<'_, F>

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

Formats the value using the given formatter.