pub struct Formatting { /* fields omitted */ }
Run a formatter in the repository to check commits for formatting.
The formatter is passed a single argument: the path to the file which should be checked.
The formatter is expected to exit with success whether the path passed to it has a valid format
in it or not. A failure exit status is considered a failure of the formatter itself. If any
changes (including untracked files) are left inside of the worktree, it is considered to have
failed the checks.
The formatter is run with its current working directory being the top-level of the work tree,
but not the proper GIT_
context. This is because the setup for the workarea is not completely
isolated and git
commands may not behave as expected. The worktree it is working from is only
guaranteed to have the files which have changed in the commit being checked on disk, so
additional files which should be available for the command to run must be specified with
Formatting::add_config_files
.
Create a new formatting check.
Set the name of the formatter.
Add configuration files within the repository which should be checked out.
Add a message for how to fix issues with this formatter.
Add a timeout to the formatter.
Performs copy-assignment from source
. Read more
Formats the value using the given formatter. Read more
Creates owned data from borrowed data, usually by cloning. Read more
🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
🔬 This is a nightly-only experimental API. (try_from
)
The type returned in the event of a conversion error.
🔬 This is a nightly-only experimental API. (try_from
)
Immutably borrows from an owned value. Read more
🔬 This is a nightly-only experimental API. (get_type_id
)
this method will likely be replaced by an associated static
🔬 This is a nightly-only experimental API. (try_from
)
The type returned in the event of a conversion error.
🔬 This is a nightly-only experimental API. (try_from
)
Mutably borrows from an owned value. Read more