Struct ContentDisposition 

pub struct ContentDisposition<'a> { /* private fields */ }

A Content-Disposition field, as RFC 2183 defines it for MIME parts and RFC 7578 uses for form data: a disposition type, such as form-data, and parameters, such as name and filename.

Parsing borrows from the field value, copying only a quoted string with escapes. Names and filenames are returned as they were sent: RFC 7578 lets them be UTF-8, and browsers percent-encode the quotes and line breaks in them, which this type does not decode. In a quoted string, a backslash escapes only a quote or another backslash; any other backslash is kept, since browsers send Windows paths unescaped. Extended parameters, such as filename*, are kept as they were sent by parameter; name and filename apply ParameterRules to them, since forms and other MIME parts treat them differently. They are written unquoted.

A value that is not UTF-8, as a form on a page in a legacy character set may send, is invalid, as are an empty parameter, such as a trailing ;, and a value outside quotes that is not a token.

use base_web_multipart::{ContentDisposition, ParameterRules};
use base_message::FieldType;

let disposition = ContentDisposition::parse(b"form-data; name=\"avatar\"; filename=\"caf\xc3\xa9.png\"")?;
assert_eq!(disposition.disposition_type(), "form-data");
assert_eq!(disposition.name(ParameterRules::FormData)?.as_deref(), Some("avatar"));
assert_eq!(disposition.filename(ParameterRules::FormData)?.as_deref(), Some("café.png"));

let written = ContentDisposition::form_data("note")?.with_parameter("filename", "a \"quoted\" name")?;
assert_eq!(written.to_string(), "form-data; name=\"note\"; filename=\"a \\\"quoted\\\" name\"");

Implementations

impl ContentDisposition<'static>

pub fn new(disposition_type: &str) -> Result<Self, FieldValueError>

A disposition without parameters, such as attachment. The type is lowercased.

Errors

When the type is not a token.

pub fn form_data(name: &str) -> Result<Self, FieldValueError>

A form-data disposition for a form field with this name, as RFC 7578 section 4.2 requires of each part.

Errors

When the name contains a control character, such as CR or LF, which a quoted string cannot carry.

impl<'a> ContentDisposition<'a>

pub fn with_parameter( self, name: &str, value: &str, ) -> Result<ContentDisposition<'a>, FieldValueError>

The disposition with a parameter added. The name is lowercased.

Errors

When the name is not a token or is already present, the value contains a control character other than horizontal tab, the name ends with *, marking an RFC 8187 extended value, and the value is not a token, or the disposition already has the most parameters it may have.

pub fn disposition_type(&self) -> &str

The lowercase disposition type, such as form-data, attachment, or inline.

pub fn parameter(&self, name: &str) -> Option<&str>

The value of a parameter. Names are compared case-insensitively.

pub fn parameters(&self) -> impl ExactSizeIterator<Item = (&str, &str)>

The lowercase parameter names and their values, in order.

pub fn name( &self, rules: ParameterRules, ) -> Result<Option<Cow<'_, str>>, FieldValueError>

The name parameter, a form field’s name, following these rules for extended parameters.

Errors

When the rules do not allow the disposition’s extended parameters, or an extended name* cannot be decoded.

pub fn filename( &self, rules: ParameterRules, ) -> Result<Option<Cow<'_, str>>, FieldValueError>

The filename parameter, a file’s name as the sender gave it, following these rules for extended parameters. It must not be used as a local path without checking it.

Errors

When the rules do not allow the disposition’s extended parameters, or an extended filename* cannot be decoded.

pub fn into_owned(self) -> ContentDisposition<'static>

The disposition, owning its text.

Trait Implementations

impl<'a> Clone for ContentDisposition<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ContentDisposition<'_>

Shows the disposition type and parameter names, and the lengths of parameter values, since a form field’s name or a filename can identify a person.

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

Formats the value using the given formatter.

impl Display for ContentDisposition<'_>

Writes the disposition as a field value, with every parameter value quoted except extended values.

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

Formats the value using the given formatter.

impl<'a> Eq for ContentDisposition<'a>

impl<'a> FieldType<'a> for ContentDisposition<'a>

type Combination = Singleton

One of the markers in combination: Singleton, List, or Separate.

fn parse(value: &'a [u8]) -> Result<Self, FieldValueError>

Parse one instance, or one element of a list, with surrounding spaces and tabs already removed.

const INVALID: InvalidValue = InvalidValue::Error

What an invalid value means, unless a declaration overrides it with invalid = "...". A required declaration always treats an invalid value as an error.

impl<'a> Hash for ContentDisposition<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq for ContentDisposition<'a>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<'a> StructuralPartialEq for ContentDisposition<'a>