Enum ConfigError

pub enum ConfigError {
    InvalidConfigValue {
        field_name: String,
        value: String,
        reason: String,
    },
    MissingRequiredConfig {
        field_name: String,
        field_type: String,
        possible_values: Vec<String>,
    },
    UnrecognizedConfig {
        field_name: String,
        field_value: String,
        possible_confusables: Vec<String>,
    },
    Unspecified {
        message: String,
    },
    InternalError {
        message: String,
    },
    FileNotFound {
        file_path: String,
    },
    ParseError {
        source: String,
        message: String,
    },
    EnvVarNotSet {
        env_var_name: String,
        purpose: String,
    },
    MissingProgram {
        program_name: String,
    },
}

Errors specific to the execution of Plugin::set_configuration() to configure a Hipcheck plugin.

Variants

InvalidConfigValue

The config key was valid, but the associated value was invalid

Fields

field_name: String

value: String

reason: String

MissingRequiredConfig

The config was missing an expected field

Fields

field_name: String

field_type: String

possible_values: Vec<String>

UnrecognizedConfig

The config included an unrecognized field

Fields

field_name: String

field_value: String

possible_confusables: Vec<String>

Unspecified

An unspecified error

Fields

message: String

InternalError

The plugin encountered an error, probably due to incorrect assumptions.

Fields

message: String

FileNotFound

A necessary plugin input file was not found.

Fields

file_path: String

ParseError

The plugin’s input data could not be parsed correctly.

Fields

source: String

message: String

EnvVarNotSet

An environment variable needed by the plugin was not set.

Fields

env_var_name: String

Name of the environment variable

purpose: String

Message describing what the environment variable should contain

MissingProgram

The plugin could not run a needed program.

Fields

program_name: String

Trait Implementations

impl Debug for ConfigError

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

Formats the value using the given formatter.

impl From<ConfigError> for SetConfigurationResponse

fn from(value: ConfigError) -> Self

Converts to this type from the input type.