Struct Repo 

pub struct Repo {
    pub path: PathBuf,
    pub conf: Config,
}

Fields

path: PathBuf

The absolute path of the opened repo.

conf: Config

Implementations

impl Repo

pub fn open(path: impl AsRef<Path>) -> Result<Self>

Open a repo. The path argument must be an absolute path.

pub fn path(&self) -> &Path

pub fn to_absolute_path(&self, path: impl AsRef<Path>) -> PathBuf

pub fn get_key(&self) -> Result<String>

Read the master key from git config.

Returns an error if the key has not been configured.

pub fn set_key_interactive(&self) -> Result<()>

Set the key interactively by prompting on stdin.

pub fn check(&self, paths: &[PathBuf], staged: bool) -> Result<()>

Check if all files in the crypt list (or given paths) are encrypted.

When staged is true, only files staged for the current commit are checked, by intersecting staged files against the crypt list. This is used by the pre-commit hook to avoid checking the entire repo.

Returns Ok(()) if all files are encrypted, or an error summarizing which files are not encrypted. The process exits with a non-zero code when files are not encrypted, suitable for CI usage.

pub fn install_hook(&self) -> Result<()>

Install a pre-commit hook that runs git-se check before each commit.

Creates <repo>/.git/hooks/pre-commit with the check script. Fails if a hook already exists and is not managed by git-se.

pub fn run(&self, args: &[&str]) -> Result<()>

Run a git command in the repo, discarding its stdout/stderr.

pub fn run_with_output(&self, args: &[&str]) -> Result<String>

Run a git command and return its trimmed stdout as a String.

pub fn set_config(&self, key: &str, value: &str) -> Result<()>

Write a value to <prefix>.<key> in the repo-local git config.

Note: the value is stored verbatim (no trimming), so callers should sanitize it themselves if needed. This matters for the key field, which holds a user-supplied password and must not be silently modified.

pub fn get_config(&self, key: &str) -> Result<String>

Read <prefix>.<key> from the repo-local git config.

Trait Implementations

impl Clone for Repo

fn clone(&self) -> Repo

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Repo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Repo

fn default() -> Repo

Returns the “default value” for a type.