Struct Repository 

pub struct Repository { /* private fields */ }

Git repository for a Rust advisory DB.

Implementations

impl Repository

pub fn default_path() -> PathBuf

Location of the default advisory-db repository for crates.io

pub fn fetch_default_repo() -> Result<Self, Error>

Fetch the default repository.

Locking

This function will wait for up to 5 minutes for the filesystem lock on the repository. It will fail with rustsec::Error::LockTimeout if the lock is still held after that time. Use Repository::fetch if you need to configure locking behavior.

pub fn fetch<P: Into<PathBuf>>( url: &str, into_path: P, ensure_fresh: bool, lock_timeout: Duration, ) -> Result<Self, Error>

Create a new Repository with the given URL and path, and fetch its contents.

Locking

This function will wait for up to lock_timeout for the filesystem lock on the repository. It will fail with rustsec::Error::LockTimeout if the lock is still held after that time.

If lock_timeout is set to std::time::Duration::from_secs(0), it will not wait at all, and instead return an error immediately if it fails to aquire the lock.

pub fn open<P: Into<PathBuf>>(into_path: P) -> Result<Self, Error>

Open a repository at the given path

pub fn latest_commit(&self) -> Result<Commit, Error>

Get information about the latest commit to the repo

pub fn path(&self) -> &Path

Path to the local checkout of a git repository

pub fn has_relative_path(&self, path: &Path) -> bool

Determines if the tree pointed to by HEAD contains the specified path