Struct poem::web::type_headers::ContentEncoding

pub struct ContentEncoding(_);

This is supported on crate feature typed-headers only.

Content-Encoding header, defined in RFC7231

The Content-Encoding header field indicates what content codings have been applied to the representation, beyond those inherent in the media type, and thus what decoding mechanisms have to be applied in order to obtain data in the media type referenced by the Content-Type header field. Content-Encoding is primarily used to allow a representation’s data to be compressed without losing the identity of its underlying media type.

ABNF

Content-Encoding = 1#content-coding

Example values

• gzip

Implementations

impl ContentEncoding

pub fn new(values: Vec<ContentCoding, Global>) -> Result<ContentEncoding, Error>

Methods from Deref<Target = Vec<ContentCoding, Global>>

pub fn capacity(&self) -> usize

Returns the number of elements the vector can hold without reallocating.

Examples

let vec: Vec<i32> = Vec::with_capacity(10);
assert_eq!(vec.capacity(), 10);

pub fn as_slice(&self) -> &[T]

Extracts a slice containing the entire vector.

Equivalent to &s[..].

Examples

use std::io::{self, Write};
let buffer = vec![1, 2, 3, 5, 8];
io::sink().write(buffer.as_slice()).unwrap();

pub fn as_ptr(&self) -> *const T

Returns a raw pointer to the vector’s buffer.

The caller must ensure that the vector outlives the pointer this function returns, or else it will end up pointing to garbage. Modifying the vector may cause its buffer to be reallocated, which would also make any pointers to it invalid.

The caller must also ensure that the memory the pointer (non-transitively) points to is never written to (except inside an UnsafeCell) using this pointer or any pointer derived from it. If you need to mutate the contents of the slice, use as_mut_ptr.

Examples

let x = vec![1, 2, 4];
let x_ptr = x.as_ptr();

unsafe {
    for i in 0..x.len() {
        assert_eq!(*x_ptr.add(i), 1 << i);
    }
}

pub fn allocator(&self) -> &A

🔬 This is a nightly-only experimental API. (allocator_api)

Returns a reference to the underlying allocator.

pub fn len(&self) -> usize

Returns the number of elements in the vector, also referred to as its ‘length’.

Examples

let a = vec![1, 2, 3];
assert_eq!(a.len(), 3);

pub fn is_empty(&self) -> bool

Returns true if the vector contains no elements.

Examples

let mut v = Vec::new();
assert!(v.is_empty());

v.push(1);
assert!(!v.is_empty());

Trait Implementations

impl Clone for ContentEncoding

pub fn clone(&self) -> ContentEncoding

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ContentEncoding

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

Formats the value using the given formatter.

impl Deref for ContentEncoding

type Target = Vec<ContentCoding, Global>

The resulting type after dereferencing.

pub fn deref(&self) -> &Vec<ContentCoding, Global>

Dereferences the value.

impl From<ContentCoding> for ContentEncoding

pub fn from(value: ContentCoding) -> ContentEncoding

Performs the conversion.

impl Header for ContentEncoding

pub fn name() -> &'static HeaderName

Returns the name of this header.

pub fn from_values(
    values: &mut ValueIter<'_, HeaderValue>
) -> Result<Option<ContentEncoding>, Error>

Parses the header from the raw value bytes.

pub fn to_values(&self, values: &mut ToValues<'_>)

Serializes the header to raw values.

impl PartialEq<ContentEncoding> for ContentEncoding

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

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

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

This method tests for !=.

impl StructuralPartialEq for ContentEncoding