Struct ContentDisposition 

#[non_exhaustive]
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 (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

disposition_type: ContentDispositionType

The disposition type.

filename: Option<String>

The filename of the content.

Implementations

impl ContentDisposition

pub fn new(disposition_type: ContentDispositionType) -> Self

Creates a new ContentDisposition with the given disposition type.

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

Add the given filename to this ContentDisposition.

Trait Implementations

impl Clone for ContentDisposition

fn clone(&self) -> ContentDisposition

Returns a duplicate 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

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

Formats the value using the given formatter.

impl Eq for ContentDisposition

impl FromStr for ContentDisposition

type Err = ContentDispositionParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl PartialEq for ContentDisposition

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ContentDisposition

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ContentDisposition

impl ToSchema for ContentDisposition

fn to_schema(components: &mut Components) -> RefOr<Schema>

Returns a tuple of name and schema or reference to a schema that can be referenced by the name or inlined directly to responses, request bodies or parameters.

impl TryFrom<&[u8]> for ContentDisposition

type Error = ContentDispositionParseError

The type returned in the event of a conversion error.

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

Performs the conversion.