Enum inkwell::module::FlagBehavior

pub enum FlagBehavior {
    Error,
    Warning,
    Require,
    Override,
    Append,
    AppendUnique,
}

Available on crate features llvm7-0 or llvm8-0 or llvm9-0 or llvm10-0 or llvm11-0 or llvm12-0 or llvm13-0 or llvm14-0 or llvm15-0 or llvm16-0 or llvm17-0 or llvm18-0 only.

Defines the operational behavior for a module wide flag. This documentation comes directly from the LLVM docs

Variants

Error

Emits an error if two values disagree, otherwise the resulting value is that of the operands.

Warning

Emits a warning if two values disagree. The result value will be the operand for the flag from the first module being linked.

Require

Adds a requirement that another module flag be present and have a specified value after linking is performed. The value must be a metadata pair, where the first element of the pair is the ID of the module flag to be restricted, and the second element of the pair is the value the module flag should be restricted to. This behavior can be used to restrict the allowable results (via triggering of an error) of linking IDs with the Override behavior.

Override

Uses the specified value, regardless of the behavior or value of the other module. If both modules specify Override, but the values differ, an error will be emitted.

Append

Appends the two values, which are required to be metadata nodes.

AppendUnique

Appends the two values, which are required to be metadata nodes. However, duplicate entries in the second list are dropped during the append operation.

Trait Implementations

impl Clone for FlagBehavior

fn clone(&self) -> FlagBehavior

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FlagBehavior

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

Formats the value using the given formatter.

impl From<LLVMModuleFlagBehavior> for FlagBehavior

fn from(src: LLVMModuleFlagBehavior) -> Self

Converts to this type from the input type.

impl Hash for FlagBehavior

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Into<LLVMModuleFlagBehavior> for FlagBehavior

fn into(self) -> LLVMModuleFlagBehavior

Converts this type into the (usually inferred) input type.

impl Ord for FlagBehavior

fn cmp(&self, other: &FlagBehavior) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for FlagBehavior

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for FlagBehavior

fn partial_cmp(&self, other: &FlagBehavior) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for FlagBehavior

impl Eq for FlagBehavior

impl StructuralPartialEq for FlagBehavior