Struct Agent

pub struct Agent {
    pub pid: String,
    pub socket_path: PathBuf,
    pub is_running: bool,
}

The SSH agent concept struct.

Fields

pid: String

socket_path: PathBuf

is_running: bool

Implementations

impl Agent

pub fn clean_dead_agent_socket(&self) -> Result<()>

impl Agent

pub fn print_env_commands(&self)

Print the env value exports that would be set by an initialization.

pub fn kill_and_clean_agent(&mut self)

Kill the agent and ensure the socket paths are cleaned afterwards.

If the agent was alive when this function is called, the ssh-agent invocation will handle the path and process clean up. If it was not alive, Agency will attempt to handle these clean up steps.

pub fn kill_agent(&mut self)

Kill the agent via the ssh-agent tool.

pub fn check_agent_identities( &self, ) -> Result<AgentIdentityStatus, Box<dyn Error>>

Check the identities present on the agent.

If the agent is not alive, this will return AgentIdentityStatus::ConnectionRefused.

Trait Implementations

impl Clone for Agent

fn clone(&self) -> Agent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Agent

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

Formats the value using the given formatter.

impl Default for Agent

fn default() -> Agent

Returns the “default value” for a type.

impl Display for Agent

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

Formats the value using the given formatter.

impl PartialEq for Agent

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Agent

impl StructuralPartialEq for Agent