Struct distant_core::Destination

pub struct Destination {
    pub scheme: Option<String>,
    pub username: Option<String>,
    pub password: Option<String>,
    pub host: Host,
    pub port: Option<u16>,
}

distant connects and logs into the specified destination, which may be specified as either hostname:port where an attempt to connect to a distant server will be made, or a URI of one of the following forms:

• distant://hostname:port - connect to a distant server
• ssh://[user@]hostname[:port] - connect to an SSH server

Note: Due to the limitations of a URI, an IPv6 address is not supported.

Fields

scheme: Option<String>

Sequence of characters beginning with a letter and followed by any combination of letters, digits, plus (+), period (.), or hyphen (-) representing a scheme associated with a destination

username: Option<String>

Sequence of alphanumeric characters representing a username tied to a destination

password: Option<String>

Sequence of alphanumeric characters representing a password tied to a destination

host: Host

Consisting of either a registered name (including but not limited to a hostname) or an IP address. IPv4 addresses must be in dot-decimal notation, and IPv6 addresses must be enclosed in brackets ([])

port: Option<u16>

Port tied to a destination

Implementations

impl Destination

pub fn is_distant(&self) -> bool

Returns true if destination represents a distant server

pub fn is_ssh(&self) -> bool

Returns true if destination represents an ssh server

Trait Implementations

impl AsMut<Destination> for &mut Destination

fn as_mut(&mut self) -> &mut Destination

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<Destination> for &Destination

fn as_ref(&self) -> &Destination

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Destination

fn clone(&self) -> Destination

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Destination

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Destination

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

Deserialize this value from the given Serde deserializer.

impl Display for Destination

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

Formats the value using the given formatter.

impl FromStr for Box<Destination>

type Err = &'static str

The associated error which can be returned from parsing.

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

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

impl FromStr for Destination

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

Parses a destination in the form [scheme://][[username][:password]@]host[:port]

type Err = &'static str

The associated error which can be returned from parsing.

impl Hash for Destination

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq<&'a str> for Destination

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

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

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 Destination

impl StructuralEq for Destination

impl StructuralPartialEq for Destination