AnnotatedCommit class

A class representing an annotated commit in Git.

An annotated commit contains information about how it was looked up, which may be useful for functions like merge or rebase to provide context to the operation. For example, conflict files will include the name of the source or target branches being merged.

Annotations

• @immutable

Constructors

AnnotatedCommit.fromFetchHead({required Repository repo, required String branchName, required String remoteUrl, required Oid oid})

Creates an annotated commit from the given fetch head data.

AnnotatedCommit.fromReference({required Repository repo, required Reference reference})

Creates an annotated commit from the given reference.

AnnotatedCommit.fromRevSpec({required Repository repo, required String spec})

Creates an annotated commit from a revision string.

AnnotatedCommit.lookup({required Repository repo, required Oid oid})

Creates an annotated commit by looking up the given commit oid.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

oid → Oid

The commit OID that this annotated commit refers to.

no setter

props → List<Object?>

The list of properties that will be used to determine whether two instances are equal.

no setter

refName → String

The reference name that this annotated commit refers to.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

stringify → bool?

If set to true, the toString method will be overridden to output this instance's props.

no setter, inherited

Methods

free() → void

Releases memory allocated for the commit object.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited