Struct git_checks::config::InvalidPathsConfig

pub struct InvalidPathsConfig { /* private fields */ }

Configuration for the InvalidPaths check.

The invalid_characters key is a string containing characters which are not allowed to appear in paths. By default, its value is "<>:\"|?*" which excludes characters not allowed in paths on Windows. The allow_space key is a boolean defaulting to false which specifies whether ASCII space is allowed (whitespace is otherwise disallowed).

This check is registered as a commit check with the name "invalid_paths" and a topic check with the name "invalid_paths/topic".

Example

{
    "invalid_characters": "<>:\"|?*",
    "allow_space": false
}

Trait Implementations

impl Debug for InvalidPathsConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InvalidPathsConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl IntoCheck for InvalidPathsConfig

type Check = InvalidPaths

The check parsed by this configuration.

fn into_check(self) -> Self::Check

Create a new instance of the check from the configuration.