Module git_checks::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.

Error

The Error type.

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.

ErrorKind

The kind of an error.

FileName

A representation of filenames as given by Git.

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.

ResultExt

Additional methods for Result, for easy interaction with this crate.

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.

Type Definitions

Result

Convenient wrapper around std::Result.