Struct SessionHeader 

#[non_exhaustive]
pub struct SessionHeader {
    pub id: String,
    pub timeout: Option<Duration>,
    pub extensions: Vec<(String, Option<String>)>,
}

A parsed Session header (RFC 2326 §12.37).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: String

The session identifier (opaque).

timeout: Option<Duration>

The declared timeout, if any (a malformed value is DEFAULT_SESSION_TIMEOUT).

extensions: Vec<(String, Option<String>)>

Unknown parameters (name, value) in input order.

Implementations

impl SessionHeader

pub fn new(id: impl Into<String>) -> Self

A header carrying only id.

pub fn parse(value: &str) -> Result<Self>

Parses a Session field value; see the module docs for the leniency rules.

pub fn parse_with_warnings(value: &str) -> Result<(Self, Vec<String>)>

Like parse, also returning the recoverable problems found (e.g. a malformed timeout that fell back to the default).

pub fn to_header_value(&self) -> Result<String>

Canonical serialization: id[;timeout=N][;ext[=value]]….

Errors

Error::HeaderSerialize if the id is not a valid session-id, an extension name is not an RFC 2326 §15.1 token, or a value holds a control character; nothing unsafe is ever written.

Trait Implementations

impl Clone for SessionHeader

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionHeader

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SessionHeader

Available on crate feature serde only.

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SessionHeader

impl PartialEq for SessionHeader

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SessionHeader

Available on crate feature serde only.

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SessionHeader