Struct async_nats::header::HeaderMap

source ·
pub struct HeaderMap { /* private fields */ }
Expand description

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", headers, "payload".into())
    .await?;

Implementations§

source§

impl HeaderMap

source

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

source§

impl HeaderMap

source

pub fn new() -> Self

Create an empty HeaderMap.

§Examples
let map = HeaderMap::new();

assert!(map.is_empty());
source

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

§Examples
let mut map = HeaderMap::new();

assert!(map.is_empty());

map.insert(NATS_SUBJECT, "FOO.BAR");

assert!(!map.is_empty());
source§

impl HeaderMap

source

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

Inserts a new value to a HeaderMap.

§Examples
use async_nats::HeaderMap;

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

pub fn append<K: IntoHeaderName, V: IntoHeaderValue>( &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
use async_nats::HeaderMap;

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

pub fn get<K: IntoHeaderName>(&self, key: K) -> Option<&HeaderValue>

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

§Examples

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

pub fn get_last<K: IntoHeaderName>(&self, key: K) -> Option<&HeaderValue>

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

§Examples

let mut headers = HeaderMap::new();
headers.append("Key", "Value");
let values = headers.get_last("Key").unwrap();
source

pub fn get_all<K: IntoHeaderName>(&self, key: K) -> GetAll<'_, HeaderValue>

Gets an iterator to the values for a given key.

§Examples

let mut headers = HeaderMap::new();
headers.append("Key", "Value1");
headers.append("Key", "Value2");
let mut values = headers.get_all("Key");
let value1 = values.next();
let value2 = values.next();

Trait Implementations§

source§

impl Clone for HeaderMap

source§

fn clone(&self) -> HeaderMap

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 HeaderMap

source§

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

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

impl Default for HeaderMap

source§

fn default() -> HeaderMap

Returns the “default value” for a type. Read more
source§

impl<'de> Deserialize<'de> for HeaderMap

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl FromIterator<(HeaderName, HeaderValue)> for HeaderMap

source§

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

Creates a value from an iterator. Read more
source§

impl PartialEq for HeaderMap

source§

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

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

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

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

impl Serialize for HeaderMap

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl Eq for HeaderMap

source§

impl StructuralPartialEq for HeaderMap

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§

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<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

source§

type Output = T

Should always be Self
source§

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

source§

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, U> TryFrom<U> for T
where U: Into<T>,

source§

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>,

source§

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<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
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,