Enum ProtocolVersion 

#[non_exhaustive]
pub enum ProtocolVersion {
    V1,
    V2,
}

The relay protocol version negotiated between client and server.

Sent as the websocket sub-protocol header Sec-Websocket-Protocol from the client. The server picks the best supported version and replies with it.

Variants are ordered by preference (highest first), so the Ord impl can be used during negotiation to pick the best version.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

V1

Version 1 (the only version supported until iroh 0.98.0)

V2

Version 2 (added in iroh 0.98.0)

• Removed Health frame (id 11)
• Added Status frame (id 13)

Implementations

impl ProtocolVersion

pub const ALL: &'static [Self]

All supported protocol versions, in order of preference (newest first).

pub fn all() -> impl Iterator<Item = &'static str>

Returns an iterator of all supported protocol version identifiers, in order of preference.

pub fn all_joined() -> String

Returns a comma-separated string of all supported protocol version identifiers.

pub fn all_as_header_value() -> HeaderValue

Returns all supported protocol versions in a comma-separated string as an HTTP header value.

pub fn to_str(&self) -> &'static str

Returns the protocol version identifier string.

pub fn match_from_str(s: &str) -> Option<Self>

Tries to parse a ProtocolVersion from s.

Returns None if s is not a valid protocol version string.

pub fn to_header_value(&self) -> HeaderValue

Returns this protocol version as an HTTP header value.

Trait Implementations

impl Clone for ProtocolVersion

fn clone(&self) -> ProtocolVersion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProtocolVersion

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

Formats the value using the given formatter.

impl Default for ProtocolVersion

fn default() -> ProtocolVersion

Returns the “default value” for a type.

impl Display for ProtocolVersion

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

Formats the value using the given formatter.

impl<'_derivative_strum> From<&'_derivative_strum ProtocolVersion> for &'static str

fn from(x: &'_derivative_strum ProtocolVersion) -> &'static str

Converts to this type from the input type.

impl From<ProtocolVersion> for &'static str

fn from(x: ProtocolVersion) -> &'static str

Converts to this type from the input type.

impl FromStr for ProtocolVersion

type Err = UnsupportedRelayProtocolVersion

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<ProtocolVersion, <Self as FromStr>::Err>

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

impl Ord for ProtocolVersion

fn cmp(&self, other: &ProtocolVersion) -> 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 ProtocolVersion

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for ProtocolVersion

fn partial_cmp(&self, other: &ProtocolVersion) -> 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 TryFrom<&str> for ProtocolVersion

type Error = UnsupportedRelayProtocolVersion

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<ProtocolVersion, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl Copy for ProtocolVersion

impl Eq for ProtocolVersion

impl StructuralPartialEq for ProtocolVersion