Struct AuthAgent 

pub struct AuthAgent {
    pub tx_cancel: Sender<()>,
    pub rx_cancel: Receiver<()>,
    pub tx_passphrase: Sender<String>,
    pub rx_passphrase: Receiver<String>,
    pub tx_username_password: Sender<(String, String)>,
    pub rx_username_password: Receiver<(String, String)>,
    pub psk_required: Arc<AtomicBool>,
    pub private_key_passphrase_required: Arc<AtomicBool>,
    pub password_required: Arc<AtomicBool>,
    pub username_and_password_required: Arc<AtomicBool>,
    pub event_sender: UnboundedSender<Event>,
}

Fields

tx_cancel: Sender<()>

rx_cancel: Receiver<()>

tx_passphrase: Sender<String>

rx_passphrase: Receiver<String>

tx_username_password: Sender<(String, String)>

rx_username_password: Receiver<(String, String)>

psk_required: Arc<AtomicBool>

private_key_passphrase_required: Arc<AtomicBool>

password_required: Arc<AtomicBool>

username_and_password_required: Arc<AtomicBool>

event_sender: UnboundedSender<Event>

Implementations

impl AuthAgent

pub fn new(sender: UnboundedSender<Event>) -> Self

Trait Implementations

impl Agent for AuthAgent

async fn request_passphrase( &self, network: &Network, ) -> Result<String, Canceled>

This method gets called when trying to connect to a network and passphrase is required.

async fn request_private_key_passphrase( &self, network: &Network, ) -> Result<String, Canceled>

This method gets called when connecting to a network that requires authentication using a locally-stored encrypted private key file, to obtain that private key’s encryption passphrase.

async fn request_user_name_and_passphrase( &self, network: &Network, ) -> Result<(String, String), Canceled>

This method gets called when connecting to a network that requires authentication using a user name and password.

async fn request_user_password( &self, network: &Network, user_name: Option<&String>, ) -> Result<String, Canceled>

This method gets called when connecting to a network that requires authentication with a user password. The user name is optionally passed in the parameter.

fn release(&self)

This method gets called when the service daemon unregisters the agent. An agent can use it to do cleanup tasks. There is no need to unregister the agent, because when this method gets called it has already been unregistered.

fn cancel(&self, _reason: CancellationReason)

This method gets called to indicate that the agent request failed before a reply was returned.

impl Clone for AuthAgent

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthAgent

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

Formats the value using the given formatter.