Struct actix_web::http::header::ContentType

source ·
pub struct ContentType(pub Mime);
Expand description

Content-Type header, defined in RFC 9110 §8.3.

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_web::{http::header::ContentType, HttpResponse};

let res_json = HttpResponse::Ok()
    .insert_header(ContentType::json());

let res_html = HttpResponse::Ok()
    .insert_header(ContentType(mime::TEXT_HTML));

Tuple Fields§

§0: Mime

Implementations§

source§

impl ContentType

source

pub fn json() -> ContentType

Constructs a Content-Type: application/json header.

source

pub fn plaintext() -> ContentType

Constructs a Content-Type: text/plain; charset=utf-8 header.

source

pub fn html() -> ContentType

Constructs a Content-Type: text/html; charset=utf-8 header.

source

pub fn xml() -> ContentType

Constructs a Content-Type: text/xml header.

source

pub fn form_url_encoded() -> ContentType

Constructs a Content-Type: application/www-form-url-encoded header.

source

pub fn jpeg() -> ContentType

Constructs a Content-Type: image/jpeg header.

source

pub fn png() -> ContentType

Constructs a Content-Type: image/png header.

source

pub fn octet_stream() -> ContentType

Constructs a Content-Type: application/octet-stream header.

Methods from Deref<Target = Mime>§

source

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);
source

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);
source

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());
source

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");
source

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

Returns an iterator over the parameters.

source

pub fn essence_str(&self) -> &str

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

Trait Implementations§

source§

impl Clone for ContentType

source§

fn clone(&self) -> ContentType

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for ContentType

source§

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

Formats the value using the given formatter. Read more
source§

impl Deref for ContentType

§

type Target = Mime

The resulting type after dereferencing.
source§

fn deref(&self) -> &Self::Target

Dereferences the value.
source§

impl DerefMut for ContentType

source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.
source§

impl Display for ContentType

source§

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

Formats the value using the given formatter. Read more
source§

impl Header for ContentType

source§

fn name() -> HeaderName

Returns the name of the header field.
source§

fn parse<M: HttpMessage>(msg: &M) -> Result<Self, ParseError>

Parse the header from a HTTP message.
source§

impl PartialEq for ContentType

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl TryIntoHeaderValue for ContentType

§

type Error = InvalidHeaderValue

The type returned in the event of a conversion error.
source§

fn try_into_value(self) -> Result<HeaderValue, Self::Error>

Try to convert value to a HeaderValue.
source§

impl Eq for ContentType

source§

impl StructuralPartialEq for ContentType

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> TryIntoHeaderPair for T
where T: Header,

source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more