Struct Protocol

pub struct Protocol(/* private fields */);

Web protocols that are relevant to Rama.

Please file an issue or open a PR if you need support for more protocols. When doing so please provide sufficient motivation and ensure it has no unintended consequences.

Implementations

impl Protocol

pub fn maybe_from_uri_scheme_str_and_method( s: Option<&Scheme>, method: Option<&Method>, ) -> Option<Protocol>

impl Protocol

pub const HTTP: Protocol

HTTP protocol.

pub const HTTPS: Protocol

HTTPS protocol.

pub const WS: Protocol

WS protocol.

pub const WSS: Protocol

WSS protocol.

pub const SOCKS5: Protocol

SOCKS5 protocol.

pub const SOCKS5H: Protocol

SOCKS5H protocol.

pub const fn from_static(s: &'static str) -> Protocol

Creates a Protocol from a str a compile time.

This function requires the static string to be a valid protocol.

It is intended to be used to facilitate the compile-time creation of custom Protocols, as known protocols are easier created by using the desired variant directly.

Panics

This function panics at compile time when the static string is not a valid protocol.

pub fn is_http(&self) -> bool

Returns true if this protocol is http(s).

pub fn is_ws(&self) -> bool

Returns true if this protocol is ws(s).

pub fn is_socks5(&self) -> bool

Returns true if this protocol is socks5.

pub fn is_secure(&self) -> bool

Returns true if this protocol is “secure” by itself.

pub fn default_port(&self) -> Option<u16>

Returns the default port for this Protocol

pub fn as_str(&self) -> &str

Returns the Protocol as a string.

Trait Implementations

impl Clone for Protocol

fn clone(&self) -> Protocol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Protocol

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

Formats the value using the given formatter.

impl Display for Protocol

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

Formats the value using the given formatter.

impl From<&Scheme> for Protocol

fn from(s: &Scheme) -> Protocol

Converts to this type from the input type.

impl From<ForwardedProtocol> for Protocol

fn from(p: ForwardedProtocol) -> Protocol

Converts to this type from the input type.

impl From<Scheme> for Protocol

fn from(s: Scheme) -> Protocol

Converts to this type from the input type.

impl FromStr for Protocol

type Err = InvalidProtocolStr

The associated error which can be returned from parsing.

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

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

impl Hash for Protocol

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Protocol

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

fn eq(&self, other: &&str) -> 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 PartialEq<Protocol> for &str

fn eq(&self, other: &Protocol) -> 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 PartialEq<Protocol> for String

fn eq(&self, other: &Protocol) -> 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 PartialEq<Protocol> for str

fn eq(&self, other: &Protocol) -> 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 PartialEq<String> for Protocol

fn eq(&self, other: &String) -> 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 PartialEq<str> for Protocol

fn eq(&self, other: &str) -> 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 PartialEq for Protocol

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

fn partial_cmp(&self, other: &Protocol) -> 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<&Protocol> for ForwardedProtocol

type Error = UnknownProtocol

The type returned in the event of a conversion error.

fn try_from( p: &Protocol, ) -> Result<ForwardedProtocol, <ForwardedProtocol as TryFrom<&Protocol>>::Error>

Performs the conversion.

impl TryFrom<&String> for Protocol

type Error = InvalidProtocolStr

The type returned in the event of a conversion error.

fn try_from( s: &String, ) -> Result<Protocol, <Protocol as TryFrom<&String>>::Error>

Performs the conversion.

impl TryFrom<&str> for Protocol

type Error = InvalidProtocolStr

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Protocol> for ForwardedProtocol

type Error = UnknownProtocol

The type returned in the event of a conversion error.

fn try_from( p: Protocol, ) -> Result<ForwardedProtocol, <ForwardedProtocol as TryFrom<Protocol>>::Error>

Performs the conversion.

impl TryFrom<String> for Protocol

type Error = InvalidProtocolStr

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Protocol, <Protocol as TryFrom<String>>::Error>

Performs the conversion.

impl Eq for Protocol

impl StructuralPartialEq for Protocol