Struct Outcome

pub struct Outcome {
    pub username: Option<String>,
    pub password: Option<String>,
    pub oauth_refresh_token: Option<String>,
    pub quit: bool,
    pub next: NextAction,
}

The outcome of the credentials helper invocation.

Fields

username: Option<String>

The username to use in the identity, if set.

password: Option<String>

The password to use in the identity, if set.

oauth_refresh_token: Option<String>

An OAuth refresh token that may accompany a password. It is to be treated confidentially, just like the password.

quit: bool

If set, the helper asked to stop the entire process, whether the identity is complete or not.

next: NextAction

A handle to the action to perform next in another call to helper::invoke().

Implementations

impl Outcome

pub fn consume_identity(&mut self) -> Option<Account>

Try to fetch username and password to form an identity. This will fail if one of them is not set.

This does nothing if only one of the fields is set, or consume both.

Trait Implementations

impl Clone for Outcome

fn clone(&self) -> Outcome

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Outcome

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

Formats the value using the given formatter.

impl PartialEq for Outcome

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

impl StructuralPartialEq for Outcome