1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
use std::{borrow::Cow, convert::TryInto};
use crate::{
bstr::{BStr, ByteSlice},
remote, Reference,
};
/// The name of a remote, either interpreted as symbol like `origin` or as url as returned by [`Reference::remote_name()`].
#[derive(Debug, PartialEq, Eq, Clone)]
pub enum Name<'repo> {
/// A symbolic name, like `origin`
Symbol(Cow<'repo, str>),
/// A url pointing to the remote host directly.
Url(Cow<'repo, BStr>),
}
mod name;
/// Remotes
impl<'repo> Reference<'repo> {
/// Find the unvalidated name of our remote for `direction` as configured in `branch.<name>.remote|pushRemote` respectively.
/// If `Some(<name>)` it can be used in [`Repository::find_remote(…)`][crate::Repository::find_remote()], or if `None` then
/// [Repository::remote_default_name()][crate::Repository::remote_default_name()] could be used in its place.
///
/// Return `None` if no remote is configured.
///
/// # Note
///
/// - it's recommended to use the [`remote(…)`][Self::remote()] method as it will configure the remote with additional
/// information.
/// - `branch.<name>.pushRemote` falls back to `branch.<name>.remote`.
pub fn remote_name(&self, direction: remote::Direction) -> Option<Name<'repo>> {
let name = self.name().shorten().to_str().ok()?;
let config = &self.repo.config.resolved;
(direction == remote::Direction::Push)
.then(|| {
config
.string("branch", Some(name), "pushRemote")
.or_else(|| config.string("remote", None, "pushDefault"))
})
.flatten()
.or_else(|| config.string("branch", Some(name), "remote"))
.and_then(|name| name.try_into().ok())
}
/// Like [`remote_name(…)`][Self::remote_name()], but configures the returned `Remote` with additional information like
///
/// - `branch.<name>.merge` to know which branch on the remote side corresponds to this one for merging when pulling.
///
/// It also handles if the remote is a configured URL, which has no name.
pub fn remote(
&self,
direction: remote::Direction,
) -> Option<Result<crate::Remote<'repo>, remote::find::existing::Error>> {
// TODO: use `branch.<name>.merge`
self.remote_name(direction).map(|name| match name {
Name::Symbol(name) => self.repo.find_remote(name.as_ref()).map_err(Into::into),
Name::Url(url) => git_url::parse(url.as_ref()).map_err(Into::into).and_then(|url| {
self.repo
.remote_at(url)
.map_err(|err| remote::find::existing::Error::Find(remote::find::Error::Init(err)))
}),
})
}
}