Enum xio_jobset_compilation::Error

pub enum Error {
    ParameterAlreadyDescribed {
        name: String,
        original_layer: String,
        offending_layer: String,
        backtrace: Backtrace,
    },
    ParameterNotYetDescribed {
        name: String,
        layer: String,
        backtrace: Backtrace,
    },
    ParameterOverrideEnforceNotRespected {
        name: String,
        layer: String,
        backtrace: Backtrace,
    },
    ParameterOverrideForbidNotSatisfied {
        name: String,
        layer: String,
        backtrace: Backtrace,
    },
    ParameterOverrideNotAllowed {
        name: String,
        layer: String,
        backtrace: Backtrace,
    },
    ParameterTypeMismatch {
        name: String,
        defined_type: DataType,
        defined_layer: String,
        value: Box<DataValueDescriptive>,
        value_layer: String,
        source: Error,
    },
    ParameterWithFixedStorageAndNoValue {
        name: String,
        backtrace: Backtrace,
    },
    MappedParameterNotFound {
        name: String,
        backtrace: Backtrace,
    },
    InstructionParameterNotFound {
        name: String,
        backtrace: Backtrace,
    },
    ParameterNotFound {
        name: String,
        backtrace: Backtrace,
    },
    ParameterNotMappedInHardwareAssignment {
        name: String,
        hardware_board: String,
        backtrace: Backtrace,
    },
    CapabilityNotFound {
        name: String,
        parameter_name: String,
        hardware_board: String,
        backtrace: Backtrace,
    },
    ModuleDescriptionNotFound {
        name: String,
        parameter_name: String,
        capability_name: String,
        hardware_board: String,
        backtrace: Backtrace,
    },
    ModuleChannelNotFound {
        name: String,
        module_name: String,
        parameter_name: String,
        backtrace: Backtrace,
    },
    ChannelDataTypeMismatch {
        index: u16,
        name: String,
        module_name: String,
        required_datatype: DataType,
        found_datatype: DataType,
        parameter_name: String,
        backtrace: Backtrace,
    },
    InvalidDataType {
        name: String,
        backtrace: Backtrace,
    },
    InstructionNotFound {
        location: CodeLocation,
        name: String,
        backtrace: Backtrace,
    },
    FoundConditionInCommands {
        location: CodeLocation,
        command_type: String,
        backtrace: Backtrace,
    },
    CommandWithoutTimeExtentButConditions {
        location: CodeLocation,
        command_type: String,
        backtrace: Backtrace,
    },
    CommandWithTimeExtentButNoConditions {
        location: CodeLocation,
        command_type: String,
        backtrace: Backtrace,
    },
    InvalidInstructionCategory {
        location: CodeLocation,
        command_type: String,
        backtrace: Backtrace,
    },
    ParametersInGroupAreOfDifferentTypes {
        location: Box<CodeLocation>,
        parameters: IndexSet<String>,
        group: String,
        backtrace: Backtrace,
    },
    WrongParameters {
        location: Box<CodeLocation>,
        found: IndexSet<String>,
        required: IndexSet<String>,
        backtrace: Backtrace,
    },
    ParameterStorageDoesNotFit {
        location: CodeLocation,
        name: String,
        required_storage: StorageTypeWithMixed,
        found_storage: StorageType,
        backtrace: Backtrace,
    },
    ProgrammerError {
        msg: String,
        backtrace: Backtrace,
    },
    XioBaseDatatypes {
        source: Error,
    },
}

An enum containing all error kinds produced by this crate.

Variants

ParameterAlreadyDescribed

A parameter was already described in a lower layer.

It can not be overwritten in a higher layer.

Fields of ParameterAlreadyDescribed

name: String

The name of the parameter in question.

original_layer: String

The layer where the parameter was described first.

offending_layer: String

The layer where the parameter gets redefined.

backtrace: Backtrace

The backtrace.

ParameterNotYetDescribed

A parameter value is defined, but was not yet described.

A lower or the same layer must contain a description of the parameter before it gets used. This description is missing at the layer where the parameter value is defined.

Fields of ParameterNotYetDescribed

name: String

The name of the parameter.

layer: String

The layer in which a definition was found.

backtrace: Backtrace

The backtrace.

ParameterOverrideEnforceNotRespected

A parameter value override is enforced, but not found.

Parameters with override=enforce must be defined at a higher layer, but no such definition was found.

Fields of ParameterOverrideEnforceNotRespected

name: String

The name of the parameter which requires override.

layer: String

The layer where the parameter is described.

backtrace: Backtrace

The backtrace.

ParameterOverrideForbidNotSatisfied

A parameter was overridden although it must not be.

Parameters with override=forbid must have their value defined in the same layer as the parameter description. A parameter was overridden in a different layer.

Fields of ParameterOverrideForbidNotSatisfied

name: String

The name of the parameter.

layer: String

The layer where the parameter was overridden.

backtrace: Backtrace

The backtrace.

ParameterOverrideNotAllowed

A parameter was overridden although it must not be.

Fields of ParameterOverrideNotAllowed

name: String

The name of the parameter.

layer: String

The layer where the parameter was overridden.

backtrace: Backtrace

The backtrace.

ParameterTypeMismatch

A parameter did not match the required type.

Fields of ParameterTypeMismatch

name: String

The name of the parameter.

defined_type: DataType

The type defined in the parameter description.

defined_layer: String

The layer where the parameter was described.

value: Box<DataValueDescriptive>

The value which was found for the parameter.

value_layer: String

The layer where the parameter value was defined.

source: Error

The source of the error.

ParameterWithFixedStorageAndNoValue

A parameter which gets stored in fixed storage has no value.

Parameters stored in fixed storage (which means const values) must have a fixed value assigned. No value assignment was found.

Fields of ParameterWithFixedStorageAndNoValue

name: String

The name of the parameter

backtrace: Backtrace

The backtrace.

MappedParameterNotFound

A parameter which was referenced by a mask does not exist.

Fields of MappedParameterNotFound

name: String

The name of the missing parameter.

backtrace: Backtrace

The backtrace.

InstructionParameterNotFound

A parameter of a instruction was not found.

Fields of InstructionParameterNotFound

name: String

The name of the missing parameter.

backtrace: Backtrace

The backtrace.

ParameterNotFound

A parameter was not found.

Fields of ParameterNotFound

name: String

The name of the missing parameter.

backtrace: Backtrace

The backtrace.

ParameterNotMappedInHardwareAssignment

No hardware mapping was found for a channel parameter.

Channel parameters must have a XIO hardware channel assigned in the hardware assignment. This assignment was not found.

Fields of ParameterNotMappedInHardwareAssignment

name: String

The name of the parameter.

hardware_board: String

The hardware board.

backtrace: Backtrace

The backtrace.

CapabilityNotFound

A required capability was not found.

Fields of CapabilityNotFound

name: String

The name of the capability.

parameter_name: String

The parameter which requires the capability.

hardware_board: String

The hardware board which is missing the capability.

backtrace: Backtrace

The backtrace.

ModuleDescriptionNotFound

A module description was not found.

Fields of ModuleDescriptionNotFound

name: String

The module name.

parameter_name: String

The name of the parameter which requires the module.

capability_name: String

The name of the capability.

hardware_board: String

The hardware board which is missing the module.

backtrace: Backtrace

The backtrace.

ModuleChannelNotFound

A channel with a certain name is not present in the module.

Fields of ModuleChannelNotFound

name: String

The name of the channel.

module_name: String

The name of the module.

parameter_name: String

The name of the parameter.

backtrace: Backtrace

The backtrace.

ChannelDataTypeMismatch

A channel parameter datatype did not match.

Fields of ChannelDataTypeMismatch

index: u16

The index of the channel within the module.

name: String

The name of the mapped channel.

module_name: String

The name of the module.

required_datatype: DataType

The required data type.

found_datatype: DataType

The data type of the parameter value.

parameter_name: String

The name of the parameter.

backtrace: Backtrace

The backtrace.

InvalidDataType

A parameter has an invalid data type.

Fields of InvalidDataType

name: String

The name of the parameter.

backtrace: Backtrace

The backtrace.

InstructionNotFound

An instruction type could not be found in the instruction set.

Fields of InstructionNotFound

location: CodeLocation

The code location in question.

name: String

The name of the missing instruction.

backtrace: Backtrace

The backtrace.

FoundConditionInCommands

A XIO condition was found where only a command is allowed.

Fields of FoundConditionInCommands

location: CodeLocation

The code location in question.

command_type: String

The type of the command.

backtrace: Backtrace

The backtrace.

CommandWithoutTimeExtentButConditions

A XIO command without time extent but with conditions was found.

XIO commands which have no time extent must not have a condition, but such a command was found with a condition attached to it.

Fields of CommandWithoutTimeExtentButConditions

location: CodeLocation

The code location in question.

command_type: String

The type of the command.

backtrace: Backtrace

The backtrace.

CommandWithTimeExtentButNoConditions

A XIO command with time extent but without conditions was found.

XIO commands which have a time extent require at least one condition, but such a command was found without a condition attached to it.

Fields of CommandWithTimeExtentButNoConditions

location: CodeLocation

The code location in question.

command_type: String

The type of the command.

backtrace: Backtrace

The backtrace.

InvalidInstructionCategory

The instruction of a command was from a different category.

Fields of InvalidInstructionCategory

location: CodeLocation

The code location in question.

command_type: String

The command type which was found.

backtrace: Backtrace

The backtrace.

ParametersInGroupAreOfDifferentTypes

Parameters inside a group don't have the same type.

Fields of ParametersInGroupAreOfDifferentTypes

location: Box<CodeLocation>

The code location in question.

parameters: IndexSet<String>

The set of parameters which have different types.

group: String

The name of the group.

backtrace: Backtrace

The backtrace.

WrongParameters

Parameters for a XIO command were wrong.

Fields of WrongParameters

location: Box<CodeLocation>

The code location in question.

found: IndexSet<String>

The set of parameters which were found.

required: IndexSet<String>

The set of parameters which are required.

backtrace: Backtrace

The backtrace.

ParameterStorageDoesNotFit

The storage of a parameter does not fit what was required.

Fields of ParameterStorageDoesNotFit

location: CodeLocation

The code location in question.

name: String

The name of the parameter.

required_storage: StorageTypeWithMixed

The required storage type constraint.

found_storage: StorageType

The storage which was found.

backtrace: Backtrace

The backtrace.

ProgrammerError

An error occurred which is probably a programmer mistake.

Fields of ProgrammerError

msg: String

A message describing the error.

backtrace: Backtrace

The backtrace.

XioBaseDatatypes

An error occurred in the xio_base_datatypes crate.

Fields of XioBaseDatatypes

source: Error

The source.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error where
    Self: Debug + Display, 

fn description(&self) -> &str

This method is soft-deprecated.

fn cause(&self) -> Option<&dyn Error>

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

The lower-level cause of this error, if any.

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

impl ErrorCompat for Error

fn backtrace(&self) -> Option<&Backtrace>

Returns a Backtrace that may be printed.