122 lines · 5.4 KB · Rust
RawDownload
use crate::{    Repository,    bstr::{BString, ByteSlice},    clone::PrepareFetch,}; /// Builderimpl PrepareFetch {    /// Use `f` to apply arbitrary changes to the remote that is about to be used to fetch a pack.    ///    /// The passed in `remote` will be un-named and pre-configured to be a default remote as we know it from git-clone.    /// It is not yet present in the configuration of the repository,    /// but each change it will eventually be written to the configuration prior to performing a the fetch operation,    /// _all changes done in `f()` will be persisted_.    ///    /// It can also be used to configure additional options, like those for fetching tags. Note that    /// [`with_fetch_tags()`](crate::Remote::with_fetch_tags()) should be called here to configure the clone as desired.    /// Otherwise, a clone is configured to be complete and fetches all tags, not only those reachable from all branches.    pub fn configure_remote(        mut self,        f: impl FnMut(crate::Remote<'_>) -> Result<crate::Remote<'_>, Box<dyn std::error::Error + Send + Sync>> + 'static,    ) -> Self {        self.configure_remote = Some(Box::new(f));        self    }     /// Set the remote's name to the given value after it was configured using the function provided via    /// [`configure_remote()`](Self::configure_remote()).    ///    /// If not set here, it defaults to `origin` or the value of `clone.defaultRemoteName`.    pub fn with_remote_name(mut self, name: impl Into<BString>) -> Result<Self, crate::remote::name::Error> {        self.remote_name = Some(crate::remote::name::validated(name)?);        Ok(self)    }     /// Make this clone a shallow one with the respective choice of shallow-ness.    pub fn with_shallow(mut self, shallow: crate::remote::fetch::Shallow) -> Self {        self.shallow = shallow;        self    }     /// Apply the given configuration `values` right before readying the actual fetch from the remote.    /// The configuration is marked with [source API](gix_config::Source::Api), and will not be written back, it's    /// retained only in memory.    pub fn with_in_memory_config_overrides(mut self, values: impl IntoIterator<Item = impl Into<BString>>) -> Self {        self.config_overrides = values.into_iter().map(Into::into).collect();        self    }     /// Set the `name` of the reference to check out, instead of the remote `HEAD`.    /// If `None`, the `HEAD` will be used, which is the default.    ///    /// Note that `name` should be a partial name like `main` or `feat/one`, but can be a full ref name.    /// If a branch on the remote matches, it will automatically be retrieved even without a refspec.    ///    /// Setting `name` to `Some(_)` clears a revision previously set with [`with_revision()`](Self::with_revision).    /// Passing `None` leaves the revision unchanged.    pub fn with_ref_name<'a, Name, E>(mut self, name: Option<Name>) -> Result<Self, E>    where        Name: TryInto<&'a gix_ref::PartialNameRef, Error = E>,    {        self.ref_name = name.map(TryInto::try_into).transpose()?.map(ToOwned::to_owned);        if self.ref_name.is_some() {            self.revision = None;        }        Ok(self)    }     /// Fetch only `revision` and check it out with a detached `HEAD`.    ///    /// A revision is either `HEAD`, a full reference name like `refs/heads/main`, or a full object ID.    /// No local or remote-tracking references are created and no fetch refspec is persisted.    /// It replaces any extra refspecs supplied with [`with_fetch_options()`](Self::with_fetch_options)    /// before fetching.    /// Setting `revision` to `Some(_)` clears a ref name previously set with [`with_ref_name()`](Self::with_ref_name).    /// Passing `None` leaves the ref name unchanged.    pub fn with_revision(        mut self,        revision: Option<impl Into<BString>>,    ) -> Result<Self, crate::clone::with_revision::Error> {        self.revision = revision            .map(|revision| {                let revision = revision.into();                let spec = gix_refspec::parse(revision.as_ref(), gix_refspec::parse::Operation::Fetch)?;                let source = spec.source().expect("one-sided non-empty fetch refspec");                let is_full_ref = source.starts_with(b"refs/") && source.find_byteset(b"*?[]\\").is_none();                let is_valid = revision.as_bstr() == source                    && spec.destination().is_none()                    && (source == "HEAD" || is_full_ref || gix_hash::ObjectId::from_hex(source).is_ok());                is_valid                    .then(|| spec.to_owned())                    .ok_or(crate::clone::with_revision::Error::Invalid { revision })            })            .transpose()?;        if self.revision.is_some() {            self.ref_name = None;        }        Ok(self)    }} /// Consumptionimpl PrepareFetch {    /// Persist the contained repository as is even if an error may have occurred when fetching from the remote.    pub fn persist(mut self) -> Repository {        self.repo.take().expect("present and consumed once")    }} impl Drop for PrepareFetch {    fn drop(&mut self) {        if let Some(repo) = self.repo.take() {            super::cleanup_clone_destination_on_drop(&repo, self.remove_worktree_on_drop);        }    }} impl From<PrepareFetch> for Repository {    fn from(prep: PrepareFetch) -> Self {        prep.persist()    }}