Enum git_credentials::helper::Action

pub enum Action {
    Get(Context),
    Store(BString),
    Erase(BString),
}

The action to perform by the credentials helper.

Variants

Get(Context)

Provide credentials using the given repository context, which must include the repository url.

Store(BString)

Approve the credentials as identified by the previous input provided as BString, containing information from Context.

Erase(BString)

Reject the credentials as identified by the previous input provided as BString. containing information from Context.

Implementations

impl Action

pub fn send(&self, write: impl Write) -> Result<()>

Send ourselves to the given write which is expected to be credentials-helper compatible

impl Action

Initialization

pub fn get_for_url(url: impl Into<BString>) -> Action

Create a Get action with context containing the given URL. Note that this creates an Action suitable for the credential helper cascade only.

Examples found in repository

examples/invoke-git-credential.rs (lines 5-9)

pub fn main() -> Result<(), Box<dyn std::error::Error>> {
    let out = git_credentials::builtin(git_credentials::helper::Action::get_for_url(
        std::env::args()
            .nth(1)
            .ok_or("First argument must be the URL to obtain credentials for")?,
    ))?
    .ok_or("Did not obtain credentials")?;
    let ctx: git_credentials::protocol::Context = (&out.next).try_into()?;
    ctx.write_to(std::io::stdout())?;
    Ok(())
}

impl Action

Access

pub fn payload(&self) -> Option<&BStr>

Return the payload of store or erase actions.

pub fn context(&self) -> Option<&Context>

Return the context of a get operation, or None.

The opposite of payload.

pub fn context_mut(&mut self) -> Option<&mut Context>

Return the mutable context of a get operation, or None.

pub fn expects_output(&self) -> bool

Returns true if this action expects output from the helper.

pub fn as_arg(&self, is_external: bool) -> &str

The name of the argument to describe this action. If is_external is true, the target program is a custom credentials helper, not a built-in one.

Trait Implementations

impl Clone for Action

fn clone(&self) -> Action

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Action

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

Formats the value using the given formatter.