Module configuration

SP configuration, especially definitions. Property definition through config file.

Structs

Configuration

GenDocOption

Package

Tag

Enums

TagType

Constants

ANY

any tag is denied in user’s spec, and special in doc generation.

ENV_SP_DIR

Folder where all toml files are searched.

ENV_SP_FILE

Single toml config file path.

LOCAL_SP_DIR

SP folder to crate being compiled.

LOCAL_SP_FILE

SP file to crate being compiled.

Functions

config_exists

If ENV_SP_DIR or ENV_SP_DIR is provided, check tag and emit #[doc] for each tag. If neither is provided, do nothing.

crate_sp_paths

Search in the crate being compiled, i.e. CARGO_MANIFEST_DIR/safety-tags.toml or CARGO_MANIFEST_DIR/safety-tags/.

doc_option

get_tag

toml_file_paths

Paths to toml config.

Type Aliases

OptStr

Str