Struct ContentDisposition 

pub struct ContentDisposition { /* private fields */ }

Represents the Content-Disposition header as defined in RFC 6266.

The Content-Disposition header is commonly used in HTTP responses to suggest a filename for a download, and to indicate whether the content should be displayed inline or as an attachment.

This implementation supports both regular parameters and the extended parameter syntax defined in RFC 5987 for internationalized filenames (filename*).

Examples

use crate::http_value::{ContentDisposition, ContentDispositionType};

// Create an attachment disposition
let disposition = ContentDisposition::attachment("report.pdf");
assert_eq!(disposition.to_string(), "attachment; filename=\"report.pdf\"");

// Parse a Content-Disposition header with extended parameter syntax
let header = "attachment; filename*=UTF-8''%F0%9F%93%96.txt";
let parsed = ContentDisposition::parse(header).unwrap();
assert_eq!(parsed.filename().unwrap(), "馃摉.txt");

Implementations

impl ContentDisposition

pub fn new(disposition_type: ContentDispositionType) -> ContentDisposition

Creates a new ContentDisposition with the specified type and no parameters.

Arguments

• disposition_type - The type of content disposition

Returns

A new ContentDisposition instance

pub fn inline() -> ContentDisposition

Creates a new ContentDisposition with type “inline”.

Returns

A new ContentDisposition instance with type set to Inline

pub fn attachment<S>(filename: S) -> ContentDisposition

where S: Into<String>,

Creates a new ContentDisposition with type “attachment”.

Arguments

• filename - Optional filename for the attachment

Returns

A new ContentDisposition instance with type set to Attachment

pub fn form_data<S, T>(name: S, filename: Option<T>) -> ContentDisposition

where S: Into<String>, T: Into<String>,

Creates a new ContentDisposition with type “form-data”.

Arguments

• name - The form field name
• filename - Optional filename for the form data

Returns

A new ContentDisposition instance with type set to FormData

pub fn parse( header: &str, ) -> Result<ContentDisposition, ContentDispositionError>

Parses a Content-Disposition header string into a ContentDisposition.

This method supports both regular parameters and extended parameters using the RFC 5987 syntax (e.g., filename*=UTF-8''file.txt).

Arguments

• header - The Content-Disposition header string

Returns

Result<ContentDisposition, ContentDispositionError> containing either the parsed disposition or an error message

Examples

use crate::http_value::ContentDisposition;

// Regular parameter
let header = "attachment; filename=\"example.txt\"";
let disposition = ContentDisposition::parse(header).unwrap();
assert_eq!(disposition.filename().unwrap(), "example.txt");

// Extended parameter
let header = "attachment; filename*=UTF-8''%F0%9F%93%96.txt";
let disposition = ContentDisposition::parse(header).unwrap();
assert_eq!(disposition.filename().unwrap(), "馃摉.txt");

pub fn disposition_type(&self) -> &ContentDispositionType

Returns the disposition type.

Returns

A reference to the ContentDispositionType

pub fn set_disposition_type(&mut self, disposition_type: ContentDispositionType)

Sets the disposition type.

Arguments

• disposition_type - The new disposition type

pub fn filename(&self) -> Option<&str>

Returns the filename, if any.

Returns

An Option<&str> containing the filename or None if no filename is not set

Per RFC 6266, the filename* parameter has precedence over filename.

pub fn set_filename<S>(&mut self, filename: S)

where S: Into<String>,

Sets the filename.

Arguments

• filename - The new filename

If the filename contains non-ASCII characters, it will automatically use the extended parameter format.

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

Gets a parameter value by name.

Arguments

• name - The parameter name

Returns

An Option<&str> containing the parameter value or None if the parameter is not set

pub fn set_parameter<K, V>(&mut self, name: K, value: V)

where K: Into<String>, V: Into<String>,

Sets a regular parameter value.

Arguments

• name - The parameter name
• value - The parameter value

pub fn set_parameter_extended<K, C, L, V>( &mut self, name: K, charset: C, language: L, value: V, )

where K: Into<String>, C: Into<String>, L: Into<String>, V: Into<String>,

Sets an extended parameter value.

Arguments

• name - The parameter name (without the trailing ‘*’)
• charset - The character set (e.g., “UTF-8”)
• language - The language tag (can be empty)
• value - The parameter value

pub fn remove_parameter(&mut self, name: &str) -> bool

Removes a parameter.

Arguments

• name - The parameter name

Returns

true if the parameter was present and removed, false otherwise

pub fn to_string(&self) -> String

Converts the ContentDisposition to its string representation suitable for use as an HTTP header value.

This method handles both regular parameters and extended parameters using the RFC 5987 syntax.

Returns

A String containing the header value

pub fn parameters(&self) -> &HashMap<String, ParameterValue>

Returns all parameters.

Returns

A reference to the parameters map

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<(), Error>

Formats the value using the given formatter.

impl PartialEq for ContentDisposition

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ContentDisposition

impl ToString for ContentDisposition

fn to_string(&self) -> String

Converts the given value to a String.