Struct git_repository::Remote

source · [−]

pub struct Remote<'repo> { /* private fields */ }

Expand description

A remote which represents a way to interact with hosts for remote clones of the parent repository.

Implementations

source

impl Remote<'_>

Builder methods

source

pub fn push_url<Url, E>(self, url: Url) -> Result<Self, Error>where
Url: TryInto<Url, Error = E>,
Error: From<E>,

Set the url to be used when pushing data to a remote.

source

pub fn push_url_without_url_rewrite<Url, E>(
 self,
 url: Url
) -> Result<Self, Error>where
 Url: TryInto<Url, Error = E>,
 Error: From<E>,

Set the url to be used when pushing data to a remote, without applying rewrite rules in case these could be faulty, eliminating one failure mode.

source

pub fn with_refspec<'a>(
 self,
 spec: impl Into<&'a BStr>,
 direction: Direction
) -> Result<Self, Error>

Add spec as refspec for direction to our list if it’s unique.

source

impl<'repo> Remote<'repo>

Establishing connections to remote hosts

source

pub fn to_connection_with_transport<T, P>(
 &self,
 transport: T,
 progress: P
) -> Connection<'_, 'repo, T, P>where
 T: Transport,
 P: Progress,

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

Create a new connection using transport to communicate, with progress to indicate changes.

Note that this method expects the transport to be created by the user, which would involve the url(). It’s meant to be used when async operation is needed with runtimes of the user’s choice.

source

pub fn connect(
 &self,
 direction: Direction,
 progress: P
) -> Result<Connection<'_, 'repo, Box<dyn Transport + Send>, P>, Error>where
 P: Progress,

Available on (crate features async-network-client or blocking-network-client) and (crate features blocking-network-client or async-network-client-async-std) only.

Connect to the url suitable for direction and return a handle through which operations can be performed.

Note that the protocol.version configuration key affects the transport protocol used to connect, with 2 being the default.

source

impl Remote<'_>

Access

source

pub fn name(&self) -> Option<&str>

Return the name of this remote or None if it wasn’t persisted to disk yet.

source

pub fn refspecs(&self, direction: Direction) -> &[RefSpec]

Return the set of ref-specs used for direction, which may be empty, in order of occurrence in the configuration.

source

pub fn url(&self, direction: Direction) -> Option<&Url>

Return the url used for the given direction with rewrites from url.<base>.insteadOf|pushInsteadOf, unless the instance was created with one of the _without_url_rewrite() methods. For pushing, this is the remote.<name>.pushUrl or the remote.<name>.url used for fetching, and for fetching it’s the remote.<name>.url. Note that it’s possible to only have the push url set, in which case there will be no way to fetch from the remote as the push-url isn’t used for that.

source

impl Remote<'_>

Modification

source

pub fn rewrite_urls(&mut self) -> Result<&mut Self, Error>

Read url.<base>.insteadOf|pushInsteadOf configuration variables and apply them to our urls, changing them in place.

This happens only once, and one if them may be changed even when reporting an error. If both urls fail, only the first error (for fetch urls) is reported.

source

pub fn replace_refspecs<Spec>(
 &mut self,
 specs: impl IntoIterator<Item = Spec>,
 direction: Direction
) -> Result<(), Error>where
 Spec: AsRef<BStr>,

Replace all currently set refspecs, typically from configuration, with the given specs for direction, or None if one of the input specs could not be parsed.