Struct HttpHeaders

Source

pub struct HttpHeaders { /* private fields */ }

Expand description

A wrapper for worker::Headers with additional methods.

This comes with two additional method which are self.len() and self.is_empty().

Implementations§

Source §

impl HttpHeaders

Source

pub fn new() -> Self

Source

pub fn get(&self, name: &HeaderName) -> Option<String>

Returns all the values of a header within a Headers object with a given name.

§Panics

Panics if HeaderName is constructed from using the method from_static and the static string is an invalid header or contains spaces.

Eg: Header contains invalid header’s name or spaces.

Source

pub fn has(&self, name: &HeaderName) -> bool

Returns a boolean stating whether a Headers object contains a certain header.

§Panics

Panics if HeaderName is constructed from using the method from_static and the static string is an invalid header or contains spaces.

Eg: Header contains invalid header’s name or spaces.

Source

pub fn len(&self) -> usize

Returns the number of elements in the headers.

Source

pub fn is_empty(&self) -> bool

Returns true if the headers contain no elements.

Source

pub fn append( &mut self, name: &HeaderName, value: &HeaderValue, ) -> Result<(), Error>

Append a header, keeping any that were set with an equivalent field name.

§Errors

Errors are returned if the header name or value is invalid (e.g. contains spaces)

§Panics

Panics if HeaderName or HeaderValue is constructed from using the method from_static and the static string is an invalid header or contains spaces.

Eg: Header contains invalid header’s name or spaces.

Source

pub fn set( &mut self, name: &HeaderName, value: &HeaderValue, ) -> Result<(), Error>

Sets a new value for an existing header inside a Headers object, or adds the header if it does not already exist.

§Errors

Errors are returned if the header name or value is invalid (e.g. contains spaces)

§Panics

Panics if HeaderName or HeaderValue is constructed from using the method from_static and the static string is an invalid header or contains spaces.

Eg: Header contains invalid header’s name or spaces.

Source

pub fn delete(&mut self, name: &HeaderName) -> Result<(), Error>

Deletes a header from a Headers object.

§Errors

Errors are returned if the header name or value is invalid (e.g. contains spaces) or if the JS Headers object’s guard is immutable (e.g. for an incoming request)

§Panics

Panics if HeaderName is constructed from using the method from_static and the static string is an invalid header or contains spaces.

Eg: Header contains invalid header’s name or spaces.

Source

pub fn entries( &self, ) -> Map<Map<IntoIter, fn(_: Result<JsValue, JsValue>) -> Array>, fn(_: Array) -> (String, String)> ⓘ

Returns an iterator allowing to go through all key/value pairs contained in this object.

Source

pub fn keys(&self) -> impl Iterator<Item = String>

Returns an iterator allowing you to go through all keys of the key/value pairs contained in this object.

Source

pub fn values(&self) -> impl Iterator<Item = String>

Returns an iterator allowing you to go through all values of the key/value pairs contained in this object.

Methods from Deref<Target = Headers>§

Source

pub fn get(&self, name: &str) -> Result<Option<String>, Error>

Returns all the values of a header within a Headers object with a given name. Returns an error if the name is invalid (e.g. contains spaces)

Source

pub fn has(&self, name: &str) -> Result<bool, Error>

Returns a boolean stating whether a Headers object contains a certain header. Returns an error if the name is invalid (e.g. contains spaces)

Source

pub fn append(&mut self, name: &str, value: &str) -> Result<(), Error>

Returns an error if the name is invalid (e.g. contains spaces)

Source

pub fn set(&mut self, name: &str, value: &str) -> Result<(), Error>

Sets a new value for an existing header inside a Headers object, or adds the header if it does not already exist. Returns an error if the name is invalid (e.g. contains spaces)

Source

pub fn delete(&mut self, name: &str) -> Result<(), Error>

Deletes a header from a Headers object. Returns an error if the name is invalid (e.g. contains spaces) or if the JS Headers object’s guard is immutable (e.g. for an incoming request)

Source