Struct async_nats::header::HeaderMap

pub struct HeaderMap { /* private fields */ }

A struct for handling NATS headers. Has a similar API to http::header, but properly serializes and deserializes according to NATS requirements.

Examples

let client = async_nats::connect("demo.nats.io").await?;
let mut headers = async_nats::HeaderMap::new();
headers.insert("Key", "Value");
client.publish_with_headers("subject".to_string(), headers, "payload".into()).await?;

Implementations

impl HeaderMap

pub fn iter(&self) -> Iter<'_, HeaderName, HeaderValue>

impl HeaderMap

pub fn new() -> Self

pub fn is_empty(&self) -> bool

impl HeaderMap

pub fn insert<K: IntoHeaderName, V: IntoHeaderValue>(&mut self, name: K, value: V)

Inserts a new value to a HeaderMap.

Examples

let mut headers = async_nats::HeaderMap::new();
headers.insert("Key", "Value");

pub fn append<K: IntoHeaderName, V: ToString>(&mut self, name: K, value: V)

Appends a new value to the list of values to a given key. If the key did not exist, it will be inserted with provided value.

Examples

let mut headers = async_nats::HeaderMap::new();
headers.append("Key", "Value");
headers.append("Key", "Another");

pub fn get<T: IntoHeaderName>(&self, name: T) -> Option<&HeaderValue>

Gets a value for a given key. If key is not found, Option::None is returned.

Examples

let mut headers = async_nats::HeaderMap::new();
headers.append("Key", "Value");
let key = headers.get("Key").unwrap();

Trait Implementations

impl Clone for HeaderMap

fn clone(&self) -> HeaderMap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HeaderMap

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

Formats the value using the given formatter.

impl Default for HeaderMap

fn default() -> HeaderMap

Returns the “default value” for a type.

impl FromIterator<(HeaderName, HeaderValue)> for HeaderMap

fn from_iter<T: IntoIterator<Item = (HeaderName, HeaderValue)>>(iter: T) -> Self

Creates a value from an iterator.

impl PartialEq<HeaderMap> for HeaderMap

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

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

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.

impl Serialize for HeaderMap

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for HeaderMap

impl StructuralEq for HeaderMap

impl StructuralPartialEq for HeaderMap