Struct git_commitgraph::file::File

[+] Show declaration

pub struct File { /* fields omitted */ }

[−] Expand description

A single commit-graph file.

All operations on a File are local to that graph file. Since a commit graph can span multiple files, all interesting graph operations belong on Graph.

Implementations

impl File[−]

[−] Expand description

Access

pub fn commit_at(&self, pos: Position) -> Commit<'_>[−]

Returns the commit data for the commit located at the given lexigraphical position.

pos must range from 0 to self.num_commits().

Panics

Panics if pos is out of bounds.

pub fn hash_kind(&self) -> HashKind

pub fn id_at(&self, pos: Position) -> Id<'_>[−]

Returns 20 bytes sha1 at the given index in our list of (sorted) sha1 hashes. The position ranges from 0 to self.num_commits()

pub fn iter_base_graph_ids(&self) -> impl Iterator<Item = Id<'_>>

pub fn iter_commits(&self) -> impl Iterator<Item = Commit<'_>>

pub fn iter_ids(&self) -> impl Iterator<Item = Id<'_>>

pub fn lookup(&self, id: Id<'_>) -> Option<Position>

pub fn num_commits(&self) -> u32[−]

Returns the number of commits in this graph file.

The maximum valid file::Position that can be used with this file is one less than num_commits().

pub fn path(&self) -> &Path

impl File[−]

pub fn at(path: impl AsRef<Path>) -> Result<File, Error>

Trait Implementations

impl Debug for File[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<'_> TryFrom<&'_ Path> for File[+]

[+] Show hidden undocumented items

type Error = Error

The type returned in the event of a conversion error.

fn try_from(path: &Path) -> Result<Self, Self::Error>[−]

Performs the conversion.