Struct distant_core::DistantSingleKeyCredentials

pub struct DistantSingleKeyCredentials {
    pub host: Host,
    pub port: u16,
    pub key: SecretKey32,
    pub username: Option<String>,
}

Represents credentials used for a distant server that is maintaining a single key across all connections

Fields

host: Host

port: u16

key: SecretKey32

username: Option<String>

Implementations

impl DistantSingleKeyCredentials

pub fn find(s: &str, strict: bool) -> Option<DistantSingleKeyCredentials>

Searches a str for distant://[username]:{key}@{host}:{port}, returning the first matching credentials set if found, failing if anything is found immediately before or after the credentials that is not whitespace or control characters

If strict is false, then the scheme can be preceded by any character

pub fn find_strict(s: &str) -> Option<DistantSingleKeyCredentials>

Equivalent to find(s, true).

pub fn find_lax(s: &str) -> Option<DistantSingleKeyCredentials>

Equivalent to find(s, false).

pub fn try_to_destination(&self) -> Result<Destination>

Converts credentials into a Destination of the form distant://[username]:{key}@{host}:{port}, failing if the credentials would not produce a valid Destination

Trait Implementations

impl Clone for DistantSingleKeyCredentials

fn clone(&self) -> DistantSingleKeyCredentials

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DistantSingleKeyCredentials

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DistantSingleKeyCredentials

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DistantSingleKeyCredentials

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

Converts credentials into string in the form of distant://[username]:{key}@{host}:{port}

impl FromStr for DistantSingleKeyCredentials

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

Parse distant://[username]:{key}@{host}:{port} as credentials. Note that this requires the distant scheme to be included. If parsing without scheme is desired, call the [DistantSingleKeyCredentials::try_from_uri_ref] method instead with require_scheme set to false

type Err = Error

The associated error which can be returned from parsing.

impl PartialEq<DistantSingleKeyCredentials> for DistantSingleKeyCredentials

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for DistantSingleKeyCredentials

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<DistantSingleKeyCredentials> for Destination

type Error = Error

The type returned in the event of a conversion error.

fn try_from( credentials: DistantSingleKeyCredentials ) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for DistantSingleKeyCredentials

impl StructuralEq for DistantSingleKeyCredentials

impl StructuralPartialEq for DistantSingleKeyCredentials