Struct ContentType 

pub struct ContentType(/* private fields */);

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 rama_http_headers::ContentType;

let ct = ContentType::json();

Implementations

impl ContentType

pub fn new(mime: Mime) -> ContentType

Create a new ContentType from any Mime.

pub fn json() -> ContentType

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

pub fn ndjson() -> ContentType

pub fn text() -> ContentType

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

pub fn text_utf8() -> ContentType

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

pub fn text_event_stream() -> ContentType

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

pub fn html() -> ContentType

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

pub fn html_utf8() -> ContentType

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

pub fn css() -> ContentType

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

pub fn css_utf8() -> ContentType

A constructor to easily create a text/css; charset=utf-8 header.

pub fn xml() -> ContentType

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

pub fn csv() -> ContentType

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

pub fn csv_utf8() -> ContentType

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

pub fn form_url_encoded() -> ContentType

A constructor to easily create a Content-Type: application/x-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.

pub fn javascript() -> ContentType

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

pub fn grpc() -> ContentType

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

pub fn javascript_utf8() -> ContentType

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

pub fn rss() -> ContentType

A constructor to easily create a Content-Type: application/rss+xml header.

pub fn atom() -> ContentType

A constructor to easily create a Content-Type: application/atom+xml header.

pub fn jose_json() -> ContentType

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

pub fn manifest_json() -> ContentType

A constructor to easily create a Content-Type: application/manifest+json header, as defined by the W3C Web App Manifest spec.

pub fn svg() -> ContentType

A constructor to easily create a Content-Type: image/svg+xml header.

use rama_http_headers::ContentType;

assert_eq!(ContentType::svg().to_string(), "image/svg+xml");

pub fn xml_utf8() -> ContentType

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

Distinct from Self::xml (which is text/xml): per RFC 7303 application/xml is preferred for sitemaps/RSS/Atom, and the charset is stated explicitly so the document’s XML prolog and the HTTP Content-Type agree.

use rama_http_headers::ContentType;

assert_eq!(
    ContentType::xml_utf8().to_string(),
    "application/xml; charset=utf-8",
);

pub fn wasm() -> ContentType

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

The spec mandates this exact value for WebAssembly.instantiateStreaming to accept the response.

use rama_http_headers::ContentType;

assert_eq!(ContentType::wasm().to_string(), "application/wasm");

pub fn woff2() -> ContentType

A constructor to easily create a Content-Type: font/woff2 header.

use rama_http_headers::ContentType;

assert_eq!(ContentType::woff2().to_string(), "font/woff2");

pub fn webmanifest() -> ContentType

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

Alias of Self::manifest_json, named after the .webmanifest file extension that web app manifests actually use; both coexist.

use rama_http_headers::ContentType;

assert_eq!(
    ContentType::webmanifest().to_string(),
    "application/manifest+json",
);

pub fn mime(&self) -> &Mime

Reference to the internal Mime.

pub fn into_mime(self) -> Mime

Consume self into the inner Mime.

Trait Implementations

impl Clone for ContentType

fn clone(&self) -> ContentType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContentType

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

Formats the value using the given formatter.

impl Display for ContentType

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

Formats the value using the given formatter.

impl From<ContentType> for Mime

fn from(ct: ContentType) -> Mime

Converts to this type from the input type.

impl From<Mime> for ContentType

fn from(m: Mime) -> ContentType

Converts to this type from the input type.

impl FromStr for ContentType

type Err = Error

The associated error which can be returned from parsing.

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

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

impl HeaderDecode for ContentType

fn decode<'i, I>(values: &mut I) -> Result<ContentType, Error>

where I: Iterator<Item = &'i HeaderValue>,

Decode this type from an iterator of HeaderValues.

impl HeaderEncode for ContentType

fn encode<E>(&self, values: &mut E)

where E: Extend<HeaderValue>,

Encode this type to a HeaderValue, and add it to a container which has HeaderValue type as each element.

fn encode_to_value(&self) -> Option<HeaderValue>

Encode this header to HeaderValue.

impl PartialEq for ContentType

fn eq(&self, other: &ContentType) -> 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 StructuralPartialEq for ContentType

impl TypedHeader for ContentType

fn name() -> &'static HeaderName

The name of this header.