Struct distant_core::DistantSingleKeyCredentials

pub struct DistantSingleKeyCredentials {
    pub host: String,
    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: String

port: u16

key: SecretKey32

username: Option<String>

Implementations

impl DistantSingleKeyCredentials

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

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

pub fn try_to_uri(&self) -> Result<URI<'static>>

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

pub fn try_from_uri_ref<'a, E>(
    uri_ref: impl TryInto<URIReference<'a>, Error = E>,
    require_scheme: bool
) -> Result<Self> where
    E: Error + Send + Sync + 'static, 

Parses credentials from a URIReference, failing if the input was not a valid URIReference or if required parameters like host or password are missing or bad format

If require_scheme is true, will enforce that a scheme is provided. Regardless, if a scheme is provided that is not distant, this will also fail

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} 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: &DistantSingleKeyCredentials) -> bool

This method tests for !=.

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 Eq for DistantSingleKeyCredentials

impl StructuralEq for DistantSingleKeyCredentials

impl StructuralPartialEq for DistantSingleKeyCredentials