Struct gix::revision::walk::Info

pub struct Info<'repo> {
    pub id: ObjectId,
    pub parent_ids: ParentIds,
    pub commit_time: Option<SecondsSinceUnixEpoch>,
    /* private fields */
}

Information about a commit that we obtained naturally as part of the iteration.

Fields

id: ObjectId

The detached id of the commit.

parent_ids: ParentIds

All parent ids we have encountered. Note that these will be at most one if Parents::First is enabled.

commit_time: Option<SecondsSinceUnixEpoch>

The time at which the commit was created. It’s only Some(_) if sorting is not Sorting::BreadthFirst, as the walk needs to require the commit-date.

Implementations

impl<'repo> Info<'repo>

Access

pub fn id(&self) -> Id<'repo>

Provide an attached version of our id field.

pub fn object(&self) -> Result<Commit<'repo>, Error>

Read the whole object from the object database.

Note that this is an expensive operation which shouldn’t be performed unless one needs more than parent ids and commit time.

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

Provide an iterator yielding attached versions of our parent_ids field.

pub fn commit_time(&self) -> SecondsSinceUnixEpoch

Returns the commit-time of this commit.

Panics

If the iteration wasn’t ordered by date.

impl<'repo> Info<'repo>

Initialization and detachment

pub fn new(info: Info, repo: &'repo Repository) -> Self

Create a new instance that represents info, but is attached to repo as well.

pub fn detach(self) -> Info

Consume this instance and remove the reference to the underlying repository.

This is useful for sending instances across threads, for example.

Trait Implementations

impl<'repo> Clone for Info<'repo>

fn clone(&self) -> Info<'repo>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'repo> Debug for Info<'repo>

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

Formats the value using the given formatter.