Struct git_checks::builders::FormattingBuilder

pub struct FormattingBuilder { /* fields omitted */ }

Builder for Formatting.

Implementations

impl FormattingBuilder

pub fn name<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

The "name" of the formatter.

This is used to refer to the formatter in use in error messages.

Configuration: Optional Default: the kind is used

pub fn kind<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

The "kind" of formatting being performed.

This is used in the name of the attribute which uses this check.

Configuration: Required

pub fn formatter<VALUE: Into<PathBuf>>(&mut self, value: VALUE) -> &mut Self

The path to the formatter.

This may be a command that exists in PATH if absolute paths are not wanted.

Configuration: Required

pub fn fix_message<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

A message to add when failures occur.

Projects which check formatting may have a way to fix it automatically. This is here so that those projects can mention their specific instructions.

Configuration: Optional Default: Unused if not provided.

pub fn timeout<VALUE: Into<Duration>>(&mut self, value: VALUE) -> &mut Self

A timeout for running the formatter.

If the formatter exceeds this timeout, it is considered to have failed.

Configuration: Optional Default: No timeout

pub fn build(&self) -> Result<Formatting, String>

Builds a new Formatting.

Errors

If a required field has not been initialized.

impl FormattingBuilder

pub fn config_files<I, F>(&mut self, files: I) -> &mut Self where
    I: IntoIterator<Item = F>,
    F: Into<String>, 

Configuration files within the repository the formatter

Configuration: Optional Default: Vec::new()

Trait Implementations

impl Clone for FormattingBuilder

fn clone(&self) -> FormattingBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for FormattingBuilder

fn default() -> FormattingBuilder

Returns the "default value" for a type.