Module impl_prelude

Module for importing all types and traits for implementing checks.

Structs

CheckGitContext

Git context for use in checks.

CheckResult

The results of a check.

Commit

Representation of a commit with information useful for commit checks.

CommitId

The Git object id of a commit.

DiffInfo

Information about a file that changed in a commit.

Identity

An identity for creating git commits.

SubmoduleContext

A git context for a submodule for use within checks.

Topic

Representation of a topic with information useful for commit checks.

Enums

AttributeState

States attributes may be in.

CommitError

Errors which can occur when working with a commit for a check.

FileName

A representation of filenames as given by Git.

GitError

Errors which may occur when working with workareas.

StatusChange

Ways a file can be changed in a commit.

Traits

BranchCheck

Interface for checks which runs once for the entire branch.

Check

Interface for checks which run for each commit.

Content

A trait for representing the content of a diff.

ContentCheck

Interface for checks which check the content of files.

Error

Error is a trait representing the basic expectations for error values, i.e., values of type E in Result<T, E>.

TopicCheck

Interface for checks which runs once for the entire branch, but with access to the content.

Functions

commit_prefix

Create a prefix to a message referencing the associated.

commit_prefix_str

Create a prefix to a message referencing the associated with a description string.