rama::net

Struct Protocol

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

Available on crate feature net only.

Expand description

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 const HTTP_SCHEME: &'static str = "http"

HTTP protocol scheme

pub const HTTP_DEFAULT_PORT: u16 = 80

HTTP protocol default port

pub const HTTP_ALT_PORT: u16 = 8080

Common alternate HTTP protocol port.

pub const HTTP_PROXY_DEFAULT_PORT: u16 = 1080

Common default port for an HTTP proxy address without an explicit port.

This follows the long-standing curl proxy-address convention. It is distinct from HTTP_DEFAULT_PORT, which is the default port for an HTTP origin server.

pub const HTTPS_SCHEME: &'static str = "https"

HTTPS protocol scheme

pub const HTTPS_DEFAULT_PORT: u16 = 443

HTTPS protocol default port

pub const HTTPS_ALT_PORT: u16 = 8443

Common alternate HTTPS protocol port.

pub const WS_SCHEME: &'static str = "ws"

WS protocol scheme

pub const WS_DEFAULT_PORT: u16 = Self::HTTP_DEFAULT_PORT

WS protocol default port

pub const WS: Protocol

WS protocol.

pub const WSS_SCHEME: &'static str = "wss"

WSS protocol scheme

pub const WSS_DEFAULT_PORT: u16 = Self::HTTPS_DEFAULT_PORT

WSS protocol default port

pub const WSS: Protocol

WSS protocol.

pub const SOCKS5_SCHEME: &'static str = "socks5"

SOCKS5 protocol scheme

pub const SOCKS5_DEFAULT_PORT: u16 = 1080

SOCKS5 protocol default port

pub const SOCKS5H_SCHEME: &'static str = "socks5h"

SOCKS5H protocol scheme

pub const SOCKS5H_DEFAULT_PORT: u16 = Self::SOCKS5_DEFAULT_PORT

SOCKS5H protocol default port

pub const FILE_SCHEME: &'static str = "file"

FILE protocol scheme. RFC 8089 — file:///path/to/x.

The file protocol. Local-filesystem URI scheme: the URI references a path on the host running the URI consumer. Consumers (CLI tools, file fetchers) open the path directly rather than dialing a network endpoint.

pub const DATA_SCHEME: &'static str = "data"

DATA protocol scheme. RFC 2397 — data:[<mediatype>][;base64],<data>.

pub const DATA: Protocol

The data protocol. Self-contained URI scheme: the URI itself carries the payload, which consumers decode in place rather than dialing a network endpoint or opening a file.

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.

Registered defaults: http=80, https=443, ws=80, wss=443, socks5=1080, socks5h=1080. Other schemes (ftp:21, ssh:22, ldap:389, …) return None — Protocol’s scope is the web-protocol set rama actively models. crate::uri::Uri::canonicalize only drops ports that match a registered default, so ftp://host:21/ keeps its :21. This diverges from WHATWG-URL (which strips ftp:21).

The set of supported protocols grows with the needs that justify them.

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

Returns the default port when this protocol is used to reach a proxy.

An HTTP proxy URL follows the long-standing curl convention of port 1080 when its authority omits a port. HTTPS, SOCKS5, and SOCKS5H use their protocol defaults. Other protocols do not have an implicit proxy port.

pub fn as_str(&self) -> &str

Returns the Protocol as a string.

pub fn canonicalize(self) -> Protocol

Return the RFC 3986 canonical presentation of this scheme.

Known protocols are stored canonically already. A custom scheme is ASCII-lowercased, allocating only when its presentation contains an uppercase letter.