Enum ssh_key::Algorithm

#[non_exhaustive]
pub enum Algorithm {
    Dsa,
    Ecdsa(EcdsaCurve),
    Ed25519,
    Rsa,
}

SSH key algorithms.

This type provides a registry of supported digital signature algorithms used for SSH keys.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Dsa

Digital Signature Algorithm

Ecdsa(EcdsaCurve)

Elliptic Curve Digital Signature Algorithm

Ed25519

Ed25519

Rsa

RSA

Implementations

impl Algorithm

pub fn new(id: &str) -> Result<Self>

Decode algorithm from the given string identifier.

Supported algorithms

• ecdsa-sha2-nistp256
• ecdsa-sha2-nistp384
• ecdsa-sha2-nistp521
• ssh-dss
• ssh-ed25519
• ssh-rsa

pub fn as_str(self) -> &'static str

Get the string identifier which corresponds to this algorithm.

pub fn is_dsa(self) -> bool

Is the algorithm DSA?

pub fn is_ecdsa(self) -> bool

Is the algorithm ECDSA?

pub fn is_ed25519(self) -> bool

Is the algorithm Ed25519?

pub fn is_rsa(self) -> bool

Is the algorithm RSA?

Trait Implementations

impl AsRef<str> for Algorithm

fn as_ref(&self) -> &str

Performs the conversion.

impl Clone for Algorithm

fn clone(&self) -> Algorithm

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Algorithm

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

Formats the value using the given formatter.

impl Display for Algorithm

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

Formats the value using the given formatter.

impl FromStr for Algorithm

type Err = Error

The associated error which can be returned from parsing.

fn from_str(id: &str) -> Result<Self>

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

impl Hash for Algorithm

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 Ord for Algorithm

fn cmp(&self, other: &Algorithm) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Algorithm> for Algorithm

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

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

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

This method tests for !=.

impl PartialOrd<Algorithm> for Algorithm

fn partial_cmp(&self, other: &Algorithm) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Algorithm

impl Eq for Algorithm

impl StructuralEq for Algorithm

impl StructuralPartialEq for Algorithm