Struct Config 

#[non_exhaustive]
pub struct Config {

    pub lintspec: BaseConfig,
    pub output: OutputConfig,
    pub constructors: WithParamsRules,
    pub contracts: ContractRules,
    pub interfaces: ContractRules,
    pub libraries: ContractRules,
    pub enums: WithParamsRules,
    pub errors: WithParamsRules,
    pub events: WithParamsRules,
    pub functions: FunctionConfig,
    pub modifiers: WithParamsRules,
    pub structs: WithParamsRules,
    pub variables: VariableConfig,
}

The parsed and validated config for the tool

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

lintspec: BaseConfig

General config for the tool

output: OutputConfig

Output config for the tool

constructors: WithParamsRules

Validation rules for constructors

contracts: ContractRules

Validation rules for contracts

interfaces: ContractRules

Validation rules for interfaces

libraries: ContractRules

Validation rules for libraries

enums: WithParamsRules

Validation rules for enums

errors: WithParamsRules

Validation rules for errors

events: WithParamsRules

Validation rules for events

functions: FunctionConfig

Validation rules for functions

modifiers: WithParamsRules

Validation rules for modifiers

structs: WithParamsRules

Validation rules for structs

variables: VariableConfig

Validation rules for state variables

Implementations

impl Config

pub fn builder() -> ConfigBuilder

Create an instance of Config using the builder syntax

impl Config

pub fn from(provider: impl Provider) -> Result<Config, Box<Error>>

pub fn figment(config_path: Option<PathBuf>) -> Figment

Create a Figment which reads the config from the default file and environment variables

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Config> for ValidationOptions

Create a ValidationOptions from a Config reference

fn from(value: &Config) -> Self

Converts to this type from the input type.

impl From<Config> for ValidationOptions

Create a ValidationOptions from a Config

fn from(value: Config) -> Self

Converts to this type from the input type.

impl PartialEq for Config

fn eq(&self, other: &Config) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Provider for Config

Implement Provider for composability

fn metadata(&self) -> Metadata

Returns the Metadata for this provider, identifying itself and its configuration sources.

fn data(&self) -> Result<Map<Profile, Dict>, Error>

Returns the configuration data.

fn profile(&self) -> Option<Profile>

Optionally returns a profile to set on the Figment this provider is merged into. The profile is only set if self is merged.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Config

impl StructuralPartialEq for Config