Struct git_repository::remote::Connection

pub struct Connection<'a, 'repo, T, P> { /* private fields */ }

Available on crate features async-network-client or blocking-network-client only.

A type to represent an ongoing connection to a remote host, typically with the connection already established.

It can be used to perform a variety of operations with the remote without worrying about protocol details, much like a remote procedure call.

Implementations

impl<'a, 'repo, T, P> Connection<'a, 'repo, T, P>

Builder

pub fn with_credentials(self, helper: impl FnMut(Action) -> Result + 'a) -> Self

Set a custom credentials callback to provide credentials if the remotes require authentication.

Otherwise we will use the git configuration to perform the same task as the git credential helper program, which is calling other helper programs in succession while resorting to a prompt to obtain credentials from the user.

A custom function may also be used to prevent accessing resources with authentication.

impl<'a, 'repo, T, P> Connection<'a, 'repo, T, P>

Access

pub fn configured_credentials(
    &self,
    url: Url
) -> Result<Box<dyn FnMut(Action) -> Result + 'a>, Error>

A utility to return a function that will use this repository’s configuration to obtain credentials, similar to what git credential is doing.

It’s meant to be used by users of the with_credentials() builder to gain access to the default way of handling credentials, which they can call as fallback.

pub fn remote(&self) -> &Remote<'repo>

Drop the transport and additional state to regain the original remote.

impl<'remote, 'repo, T, P> Connection<'remote, 'repo, T, P>where
    T: Transport,
    P: Progress,

pub fn ref_map(self) -> Result<RefMap<'remote>, Error>

List all references on the remote that have been filtered through our remote’s refspecs for fetching.

This comes in the form of all matching tips on the remote and the object they point to, along with with the local tracking branch of these tips (if available).

Note that this doesn’t fetch the objects mentioned in the tips nor does it make any change to underlying repository.