Struct JsonModel

pub struct JsonModel {
    pub paths: Vec<String>,
    pub filter_pre: Option<Vec<String>>,
    pub filter_post: Option<Vec<String>>,
    pub tidy_file: Option<PathBuf>,
    pub tidy_root: Option<PathBuf>,
    pub build_root: Option<PathBuf>,
    pub command: Option<PathBuf>,
    pub root: PathBuf,
    pub name: String,
}

Fields

paths: Vec<String>

List of paths and/or globs. This list may contain paths or shell-style globs to define the files that should be filtered. Paths or globs that resolve to folders will be silently ignored. Any path contained in this list must be specified relative to the configuration file.

filter_pre: Option<Vec<String>>

Optional list of globs used for efficiently pre-filtering paths. In contrast to the post-filter, searching will completely skip all paths and its siblings for any match with any pattern. E.g., [“.git”] will skip all “.git” folders completely. By default, i.e., if this field is not present in the configuration, the tool will skip all hidden paths and files. Set this entry to an empty list to prevent any kind of pre-filtering.

filter_post: Option<Vec<String>>

Optional list of globs to use for post-filtering. This filter will be applied for all paths after they have been resolved. In contrast to the pre-filter, siblings of paths will not be filtered without the corresponding glob. E.g., “.git” will not filter any files, only “.git/**” would. Notice that only

tidy_file: Option<PathBuf>

Optional path to a .clang-tidy yaml file (can be specified via –tidy). If no such path is provided by neither this field nor the command-line option, clang-tidy will perform a search for the compile_commands.json through all parent paths of the file to analyze.

tidy_root: Option<PathBuf>

Optional path where the .clang-tidy file should be copied to while executing.

build_root: Option<PathBuf>

Optional path to the folder that contains the compile-commands.json (can be specified via –build-root).

command: Option<PathBuf>

Optional path to the clang-tidy executable or command name

root: PathBuf

Remove text from compile-commands.json Parent directory of the Json file, used to resolve paths specified within

name: String

Lossy Json filename

Trait Implementations

impl Debug for JsonModel

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for JsonModel

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for JsonModel

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.