Struct git_checks::builders::FormattingBuilder

source · [−]

pub struct FormattingBuilder { /* private fields */ }

Expand description

Builder for Formatting.

Implementations

source

impl FormattingBuilder

source

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

source

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

source

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

source

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.

source

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

source

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

Builds a new Formatting.

Errors

If a required field has not been initialized.

source

impl FormattingBuilder

source

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

source

impl Clone for FormattingBuilder

source

fn clone(&self) -> FormattingBuilder

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Default for FormattingBuilder

source

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations

impl RefUnwindSafe for FormattingBuilder

impl Send for FormattingBuilder

impl Sync for FormattingBuilder

impl Unpin for FormattingBuilder

impl UnwindSafe for FormattingBuilder

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct git_checks::builders::FormattingBuilder

Implementations

impl FormattingBuilder

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

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

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

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

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

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

impl FormattingBuilder

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

Trait Implementations

impl Clone for FormattingBuilder

fn clone(&self) -> FormattingBuilder

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

impl Default for FormattingBuilder

fn default() -> Self

Auto Trait Implementations

impl RefUnwindSafe for FormattingBuilder

impl Send for FormattingBuilder

impl Sync for FormattingBuilder

impl Unpin for FormattingBuilder

impl UnwindSafe for FormattingBuilder

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> Pointable for T

pub const ALIGN: usize

type Init = T

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

pub unsafe fn drop(ptr: usize)

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,