Struct HeaderValue 

pub struct HeaderValue { /* private fields */ }

A string that can be used to represent an header value

HeaderValue contains raw bytes that are guaranteed ¹ to contain a valid header value that meets the following requirements:

• The value does not contain \r or \n bytes

The value may be empty and may contain arbitrary non-UTF-8 bytes: the NATS server relays header values verbatim, and other clients (like nats.go) are able to produce such values.

HeaderValue can be constructed from HeaderValue::from_static, HeaderValue::from_bytes, or any of the TryFrom implementations.

---

1. Because HeaderValue::from_dangerous_value is safe to call, unsafe code must not assume any of the above invariants. ↩

Implementations

impl HeaderValue

pub fn from_static(value: &'static str) -> Self

Construct HeaderValue from a static string

Panics

Will panic if value isn’t a valid HeaderValue

pub fn from_bytes(value: &[u8]) -> Result<Self, HeaderValueValidateError>

Construct a HeaderValue from raw bytes, validating the value

Errors

Returns an error if value contains \r or \n.

pub fn from_dangerous_value(value: Bytes) -> Self

Construct a HeaderValue from a Bytes, without checking invariants

This method bypasses invariants checks implemented by HeaderValue::from_static, HeaderValue::from_bytes, and all TryFrom implementations.

Security

While calling this method can eliminate the runtime performance cost of checking the value, constructing HeaderValue with an invalid value and then calling the NATS server with it can cause serious security issues. When in doubt use HeaderValue::from_static, HeaderValue::from_bytes, or any of the TryFrom implementations.

pub fn to_str(&self) -> Result<&str, HeaderValueToStrError>

Try to view this header value as a &str

Errors

Returns HeaderValueToStrError if the value contains bytes that are not valid UTF-8.

pub fn as_bytes(&self) -> &[u8]

Returns the raw bytes of the header value

Trait Implementations

impl AsRef<[u8]> for HeaderValue

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for HeaderValue

fn clone(&self) -> HeaderValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HeaderValue

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

Formats the value using the given formatter.

impl Display for HeaderValue

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

Formats the value using the given formatter.

impl Eq for HeaderValue

impl FromStr for HeaderValue

type Err = HeaderValueValidateError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

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

impl Ord for HeaderValue

fn cmp(&self, other: &HeaderValue) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for HeaderValue

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for HeaderValue

fn partial_cmp(&self, other: &HeaderValue) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for HeaderValue

impl TryFrom<ByteString> for HeaderValue

type Error = HeaderValueValidateError

The type returned in the event of a conversion error.

fn try_from(value: ByteString) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for HeaderValue

type Error = HeaderValueValidateError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.