Skip to main content

SshPaths

Struct SshPaths 

Source
pub struct SshPaths { /* private fields */ }
Expand description

Resolved paths for the ~/.ssh directory.

All paths are resolved relative to the user’s home directory at construction time. The Default impl returns a best-effort set of paths, falling back to ~/.ssh when the home directory cannot be resolved (e.g., in containers).

Implementations§

Source§

impl SshPaths

Source

pub fn with_dir(dir: &Path) -> SshPaths

Create an SshPaths rooted at an arbitrary directory (for tests).

Source

pub fn new() -> Result<SshPaths, Error>

Resolve paths from the user’s home directory.

§Errors

Returns Error::HomeNotFound if the home directory cannot be determined.

Source

pub fn ssh_dir(&self) -> &Path

Path to ~/.ssh.

Source

pub fn config_path(&self) -> &Path

Path to ~/.ssh/config.

Source

pub fn known_hosts_path(&self) -> &Path

Path to ~/.ssh/known_hosts.

Source

pub fn authorized_keys_path(&self) -> &Path

Path to ~/.ssh/authorized_keys.

Source

pub fn global_known_hosts_path(&self) -> &Path

Path to /etc/ssh/ssh_known_hosts (system-wide known hosts).

Source

pub fn default_key_names() -> &'static [&'static str]

Default key file name patterns to scan (without extension).

Trait Implementations§

Source§

impl Clone for SshPaths

Source§

fn clone(&self) -> SshPaths

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SshPaths

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SshPaths

Source§

fn default() -> SshPaths

Return best-effort paths, falling back to ~/.ssh if home is unavailable.

Source§

impl Eq for SshPaths

Source§

impl PartialEq for SshPaths

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SshPaths

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more