Struct GitStub 

pub struct GitStub { /* private fields */ }

Represents a git stub: a reference to a file at a specific commit.

A git stub is stored as a string in the format commit:path, and can be used to retrieve file contents via git cat-file blob commit:path.

Construct via FromStr (parsing) or GitStub::new.

Invariants

• The path is non-empty.
• The path uses forward slashes (backslashes are normalized on construction).
• Every path component is a normal file or directory name (no .., ., root /, or Windows prefixes).

Examples

use git_stub::GitStub;

let git_stub: GitStub =
    "0123456789abcdef0123456789abcdef01234567:openapi/api.json"
        .parse()
        .unwrap();

assert_eq!(git_stub.path().as_str(), "openapi/api.json");

Implementations

impl GitStub

pub fn new( commit: GitCommitHash, path: Utf8PathBuf, ) -> Result<Self, GitStubParseError>

Creates a new GitStub with the given commit hash and path.

The path is normalized: backslashes are converted to forward slashes.

Returns an error if:

• The path is empty.
• The path contains a newline character.
• Any path component is not a normal file or directory name (e.g., .., ., root /, or a Windows prefix).

pub fn commit(&self) -> GitCommitHash

Returns the commit hash.

pub fn path(&self) -> &Utf8Path

Returns the path within the repository.

pub fn to_file_contents(&self) -> String

Returns the canonical file contents for this git stub.

The canonical format is commit:path\n where:

• The path uses forward slashes (even on Windows).
• The file ends with a single newline.

pub fn needs_rewrite(&self) -> bool

Returns whether the input used to construct this GitStub was not in canonical form.

A Git stub needs rewriting if it doesn’t match the canonical format:

• Missing trailing newline.
• Contains backslashes in the path.
• Has extra whitespace.

Trait Implementations

impl Clone for GitStub

fn clone(&self) -> GitStub

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GitStub

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

Formats the value using the given formatter.

impl Display for GitStub

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

Formats the value using the given formatter.

impl FromStr for GitStub

type Err = GitStubParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for GitStub

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for GitStub

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for GitStub