Struct cargo::sources::git::GitCheckout

pub struct GitCheckout<'a> {
    database: &'a GitDatabase,
    path: PathBuf,
    revision: Oid,
    repo: Repository,
}

A local checkout of a particular revision from a GitDatabase.

Fields

database: &'a GitDatabase

The git database where this checkout is cloned from.

path: PathBuf

Path to the root of the underlying Git repository on the local filesystem.

revision: Oid

The git revision this checkout is for.

repo: Repository

Underlying Git repository instance for this checkout.

Implementations

impl<'a> GitCheckout<'a>

fn new( database: &'a GitDatabase, revision: Oid, repo: Repository ) -> GitCheckout<'a>

Creates an instance of GitCheckout. This doesn’t imply the checkout is done. Use GitCheckout::is_fresh to check.

• The database is where this checkout is from.
• The repo will be the checked out Git repository.

fn remote_url(&self) -> &Url

Gets the remote repository URL.

fn clone_into( into: &Path, database: &'a GitDatabase, revision: Oid, config: &Config ) -> CargoResult<GitCheckout<'a>>

Clone a repo for a revision into a local path from a datatabase. This is a filesystem-to-filesystem clone.

fn is_fresh(&self) -> bool

Checks if the HEAD of this checkout points to the expected revision.

fn reset(&self, config: &Config) -> CargoResult<()>

Similar to reset(). This roughly performs git reset --hard to the revision of this checkout, with additional interrupt protection by a dummy file CHECKOUT_READY_LOCK.

If we’re interrupted while performing a git reset (e.g., we die because of a signal) Cargo needs to be sure to try to check out this repo again on the next go-round.

To enable this we have a dummy file in our checkout, .cargo-ok, which if present means that the repo has been successfully reset and is ready to go. Hence if we start to do a reset, we make sure this file doesn’t exist, and then once we’re done we create the file.

fn update_submodules(&self, cargo_config: &Config) -> CargoResult<()>

Like git submodule update --recursive but for this git checkout.

This function respects submodule.<name>.update = none¹ git config. Submodules set to none won’t be fetched.

---

1. https://git-scm.com/docs/git-submodule#Documentation/git-submodule.txt-none ↩

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 64 bytes