Struct actix_web::http::header::ContentType

pub struct ContentType(pub Mime);

Content-Type header, defined in RFC7231

The Content-Type header field indicates the media type of the associated representation: either the representation enclosed in the message payload or the selected representation, as determined by the message semantics. The indicated media type defines both the data format and how that data is intended to be processed by a recipient, within the scope of the received message semantics, after any content codings indicated by Content-Encoding are decoded.

Although the mime crate allows the mime options to be any slice, this crate forces the use of Vec. This is to make sure the same header can’t have more than 1 type. If this is an issue, it’s possible to implement Header on a custom struct.

ABNF

Content-Type = media-type

Example values

• text/html; charset=utf-8
• application/json

Examples

use actix_http::Response;
use actix_http::http::header::ContentType;

let mut builder = Response::Ok();
builder.set(
    ContentType::json()
);

use mime::TEXT_HTML;
use actix_http::Response;
use actix_http::http::header::ContentType;

let mut builder = Response::Ok();
builder.set(
    ContentType(TEXT_HTML)
);

Tuple Fields

0: Mime

Implementations

impl ContentType

pub fn json() -> ContentType

A constructor to easily create a Content-Type: application/json header.

pub fn plaintext() -> ContentType

A constructor to easily create a Content-Type: text/plain; charset=utf-8 header.

pub fn html() -> ContentType

A constructor to easily create a Content-Type: text/html header.

pub fn xml() -> ContentType

A constructor to easily create a Content-Type: text/xml header.

pub fn form_url_encoded() -> ContentType

A constructor to easily create a Content-Type: application/www-form-url-encoded header.

pub fn jpeg() -> ContentType

A constructor to easily create a Content-Type: image/jpeg header.

pub fn png() -> ContentType

A constructor to easily create a Content-Type: image/png header.

pub fn octet_stream() -> ContentType

A constructor to easily create a Content-Type: application/octet-stream header.

Methods from Deref<Target = Mime>

pub fn type_(&self) -> Name<'_>

Get the top level media type for this Mime.

Example

let mime = mime::TEXT_PLAIN;
assert_eq!(mime.type_(), "text");
assert_eq!(mime.type_(), mime::TEXT);

pub fn subtype(&self) -> Name<'_>

Get the subtype of this Mime.

Example

let mime = mime::TEXT_PLAIN;
assert_eq!(mime.subtype(), "plain");
assert_eq!(mime.subtype(), mime::PLAIN);

pub fn suffix(&self) -> Option<Name<'_>>

Get an optional +suffix for this Mime.

Example

let svg = "image/svg+xml".parse::<mime::Mime>().unwrap();
assert_eq!(svg.suffix(), Some(mime::XML));
assert_eq!(svg.suffix().unwrap(), "xml");


assert!(mime::TEXT_PLAIN.suffix().is_none());

pub fn get_param<'a, N>(&'a self, attr: N) -> Option<Name<'a>> where
    N: PartialEq<Name<'a>>, 

Look up a parameter by name.

Example

let mime = mime::TEXT_PLAIN_UTF_8;
assert_eq!(mime.get_param(mime::CHARSET), Some(mime::UTF_8));
assert_eq!(mime.get_param("charset").unwrap(), "utf-8");
assert!(mime.get_param("boundary").is_none());

let mime = "multipart/form-data; boundary=ABCDEFG".parse::<mime::Mime>().unwrap();
assert_eq!(mime.get_param(mime::BOUNDARY).unwrap(), "ABCDEFG");

pub fn params(&'a self) -> Params<'a>

Returns an iterator over the parameters.

pub fn essence_str(&self) -> &str

Return a &str of the Mime’s “essence”.

Trait Implementations

impl Clone for ContentType

pub fn clone(&self) -> ContentType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ContentType

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

Formats the value using the given formatter.

impl Deref for ContentType

type Target = Mime

The resulting type after dereferencing.

pub fn deref(&self) -> &Mime

Dereferences the value.

impl DerefMut for ContentType

pub fn deref_mut(&mut self) -> &mut Mime

Mutably dereferences the value.

impl Display for ContentType

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

Formats the value using the given formatter.

impl Header for ContentType

pub fn name() -> HeaderName

Returns the name of the header field

pub fn parse<T>(msg: &T) -> Result<ContentType, ParseError> where
    T: HttpMessage, 

Parse a header

impl IntoHeaderValue for ContentType

type Error = InvalidHeaderValue

The type returned in the event of a conversion error.

pub fn try_into(
    self
) -> Result<HeaderValue, <ContentType as IntoHeaderValue>::Error>

Try to convert value to a Header value.

impl PartialEq<ContentType> for ContentType

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for ContentType

impl StructuralPartialEq for ContentType