Enum dusk_api::Limitation

pub enum Limitation {
    Top {
        setting: &'static str,
        limit: isize,
    },
    Bottom {
        setting: &'static str,
        limit: isize,
    },
    Reset {
        setting: &'static str,
    },
}

Enum that represents a system limitation, that a plugin either needs to know to work correctly, or should be notified of in case main program wants to limit some settings

When initiating the plugin, using Freight::init, a vector of limitations can be passed to the plugin, to set such limits as number of cpu threads, memory working directories, etc. If for example the main program started to do some multithreading itself, it may notify the plugin using Freight::update_limitations that the maximum amount of threads it can use was lowered from the previous amount to 1, or if the main program does not care about the amount of threads anymore, and lets the plugin decide by itself which amount it wants to use, it can send a Limitation::Reset to it.

Variants

Top

Set the maximum allowed number, represetting some setting

Fields of Top

setting: &'static strlimit: isize

Bottom

Set the minimum allowed number, representing some setting

Fields of Bottom

setting: &'static strlimit: isize

Reset

Reset the setting to default value (as if the main program has never set any value to the setting at all)

Fields of Reset

setting: &'static str