Struct ruma::http_headers::ContentDisposition

pub struct ContentDisposition {
    pub disposition_type: ContentDispositionType,
    pub filename: Option<String>,
}

The value of a Content-Disposition HTTP header.

This implementation supports the Content-Disposition header format as defined for HTTP in RFC 6266.

The only supported parameter is filename. It is encoded or decoded as needed, using a quoted string or the ext-token = ext-value format, with the encoding defined in RFC 8187.

This implementation does not support serializing to the format defined for the multipart/form-data content type in RFC 7578. It should however manage to parse the disposition type and filename parameter of the body parts.

Fields

disposition_type: ContentDispositionType

The disposition type.

filename: Option<String>

The filename of the content.

Implementations

impl ContentDisposition

pub fn new(disposition_type: ContentDispositionType) -> ContentDisposition

Available on (crate features client-api-c or client-api-s) and (crate features client or server) and crate feature api only.

Creates a new ContentDisposition with the given disposition type.

pub fn with_filename(self, filename: Option<String>) -> ContentDisposition

Available on (crate features client-api-c or client-api-s) and (crate features client or server) and crate feature api only.

Add the given filename to this ContentDisposition.

Trait Implementations

impl Clone for ContentDisposition

fn clone(&self) -> ContentDisposition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ContentDisposition

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

Formats the value using the given formatter.

impl Default for ContentDisposition

fn default() -> ContentDisposition

Returns the “default value” for a type.

impl Display for ContentDisposition

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

Formats the value using the given formatter.

impl FromStr for ContentDisposition

type Err = ContentDispositionParseError

The associated error which can be returned from parsing.

fn from_str( s: &str, ) -> Result<ContentDisposition, <ContentDisposition as FromStr>::Err>

Parses a string s to return a value of this type.

impl PartialEq for ContentDisposition

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&[u8]> for ContentDisposition

type Error = ContentDispositionParseError

The type returned in the event of a conversion error.

fn try_from( value: &[u8], ) -> Result<ContentDisposition, <ContentDisposition as TryFrom<&[u8]>>::Error>

Performs the conversion.

impl Eq for ContentDisposition

impl StructuralPartialEq for ContentDisposition