Enum llvm_ir::constant::Constant

pub enum Constant {
    Int {
        bits: u32,
        value: u64,
    },
    Float(Float),
    Null(TypeRef),
    AggregateZero(TypeRef),
    Struct {
        name: Option<String>,
        values: Vec<ConstantRef>,
        is_packed: bool,
    },
    Array {
        element_type: TypeRef,
        elements: Vec<ConstantRef>,
    },
    Vector(Vec<ConstantRef>),
    Undef(TypeRef),
    BlockAddress,
    GlobalReference {
        name: String,
        ty: TypeRef,
    },
    TokenNone,
    Add(Add),
    Sub(Sub),
    Mul(Mul),
    UDiv(UDiv),
    SDiv(SDiv),
    URem(URem),
    SRem(SRem),
    And(And),
    Or(Or),
    Xor(Xor),
    Shl(Shl),
    LShr(LShr),
    AShr(AShr),
    FAdd(FAdd),
    FSub(FSub),
    FMul(FMul),
    FDiv(FDiv),
    FRem(FRem),
    ExtractElement(ExtractElement),
    InsertElement(InsertElement),
    ShuffleVector(ShuffleVector),
    ExtractValue(ExtractValue),
    InsertValue(InsertValue),
    GetElementPtr(GetElementPtr),
    Trunc(Trunc),
    ZExt(ZExt),
    SExt(SExt),
    FPTrunc(FPTrunc),
    FPExt(FPExt),
    FPToUI(FPToUI),
    FPToSI(FPToSI),
    UIToFP(UIToFP),
    SIToFP(SIToFP),
    PtrToInt(PtrToInt),
    IntToPtr(IntToPtr),
    BitCast(BitCast),
    AddrSpaceCast(AddrSpaceCast),
    ICmp(ICmp),
    FCmp(FCmp),
    Select(Select),
}

See LLVM 14 docs on Constants. Constants can be either values, or expressions involving other constants (see LLVM 14 docs on Constant Expressions).

Variants

Int

Fields

bits: u32

Number of bits in the constant integer

value: u64

The constant value itself.

If bits == 64, this is the value.

If bits < 64, the constant value is zero-extended to fit in this field.

If bits > 64, the constant value is truncated to fit in this field; but if this truncation would change the value (i.e., if the value is >= 2^64 when interpreted as unsigned) then Module::from_bc_path() will fail. See #5.

Float(Float)

Null(TypeRef)

The TypeRef here must be to a PointerType. See LLVM 14 docs on Simple Constants

AggregateZero(TypeRef)

A zero-initialized array or struct (or scalar).

Struct

Fields

name: Option<String>

values: Vec<ConstantRef>

is_packed: bool

Array

Fields

element_type: TypeRef

elements: Vec<ConstantRef>

Vector(Vec<ConstantRef>)

Undef(TypeRef)

Undef can be used anywhere a constant is expected. See LLVM 14 docs on Undefined Values

BlockAddress

The address of the given (non-entry) BasicBlock. See LLVM 14 docs on Addresses of Basic Blocks. BlockAddress needs more fields, but the necessary getter functions are apparently not exposed in the LLVM C API (only the C++ API)

GlobalReference

Fields

name: String

Globals’ names must be strings

ty: TypeRef

Global variable or function

TokenNone

Add(Add)

Sub(Sub)

Mul(Mul)

UDiv(UDiv)

SDiv(SDiv)

URem(URem)

SRem(SRem)

And(And)

Or(Or)

Xor(Xor)

Shl(Shl)

LShr(LShr)

AShr(AShr)

FAdd(FAdd)

FSub(FSub)

FMul(FMul)

FDiv(FDiv)

FRem(FRem)

ExtractElement(ExtractElement)

InsertElement(InsertElement)

ShuffleVector(ShuffleVector)

ExtractValue(ExtractValue)

InsertValue(InsertValue)

GetElementPtr(GetElementPtr)

Trunc(Trunc)

ZExt(ZExt)

SExt(SExt)

FPTrunc(FPTrunc)

FPExt(FPExt)

FPToUI(FPToUI)

FPToSI(FPToSI)

UIToFP(UIToFP)

SIToFP(SIToFP)

PtrToInt(PtrToInt)

IntToPtr(IntToPtr)

BitCast(BitCast)

AddrSpaceCast(AddrSpaceCast)

ICmp(ICmp)

FCmp(FCmp)

Select(Select)

Trait Implementations

impl AsRef<Constant> for ConstantRef

fn as_ref(&self) -> &Constant

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Constant

fn clone(&self) -> Constant

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Constant

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

Formats the value using the given formatter.

impl Display for Constant

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

Formats the value using the given formatter.

impl From<AShr> for Constant

fn from(expr: AShr) -> Constant

Converts to this type from the input type.

impl From<Add> for Constant

fn from(expr: Add) -> Constant

Converts to this type from the input type.

impl From<AddrSpaceCast> for Constant

fn from(expr: AddrSpaceCast) -> Constant

Converts to this type from the input type.

impl From<And> for Constant

fn from(expr: And) -> Constant

Converts to this type from the input type.

impl From<BitCast> for Constant

fn from(expr: BitCast) -> Constant

Converts to this type from the input type.

impl From<ExtractElement> for Constant

fn from(expr: ExtractElement) -> Constant

Converts to this type from the input type.

impl From<ExtractValue> for Constant

fn from(expr: ExtractValue) -> Constant

Converts to this type from the input type.

impl From<FAdd> for Constant

fn from(expr: FAdd) -> Constant

Converts to this type from the input type.

impl From<FCmp> for Constant

fn from(expr: FCmp) -> Constant

Converts to this type from the input type.

impl From<FDiv> for Constant

fn from(expr: FDiv) -> Constant

Converts to this type from the input type.

impl From<FMul> for Constant

fn from(expr: FMul) -> Constant

Converts to this type from the input type.

impl From<FPExt> for Constant

fn from(expr: FPExt) -> Constant

Converts to this type from the input type.

impl From<FPToSI> for Constant

fn from(expr: FPToSI) -> Constant

Converts to this type from the input type.

impl From<FPToUI> for Constant

fn from(expr: FPToUI) -> Constant

Converts to this type from the input type.

impl From<FPTrunc> for Constant

fn from(expr: FPTrunc) -> Constant

Converts to this type from the input type.

impl From<FRem> for Constant

fn from(expr: FRem) -> Constant

Converts to this type from the input type.

impl From<FSub> for Constant

fn from(expr: FSub) -> Constant

Converts to this type from the input type.

impl From<GetElementPtr> for Constant

fn from(expr: GetElementPtr) -> Constant

Converts to this type from the input type.

impl From<ICmp> for Constant

fn from(expr: ICmp) -> Constant

Converts to this type from the input type.

impl From<InsertElement> for Constant

fn from(expr: InsertElement) -> Constant

Converts to this type from the input type.

impl From<InsertValue> for Constant

fn from(expr: InsertValue) -> Constant

Converts to this type from the input type.

impl From<IntToPtr> for Constant

fn from(expr: IntToPtr) -> Constant

Converts to this type from the input type.

impl From<LShr> for Constant

fn from(expr: LShr) -> Constant

Converts to this type from the input type.

impl From<Mul> for Constant

fn from(expr: Mul) -> Constant

Converts to this type from the input type.

impl From<Or> for Constant

fn from(expr: Or) -> Constant

Converts to this type from the input type.

impl From<PtrToInt> for Constant

fn from(expr: PtrToInt) -> Constant

Converts to this type from the input type.

impl From<SDiv> for Constant

fn from(expr: SDiv) -> Constant

Converts to this type from the input type.

impl From<SExt> for Constant

fn from(expr: SExt) -> Constant

Converts to this type from the input type.

impl From<SIToFP> for Constant

fn from(expr: SIToFP) -> Constant

Converts to this type from the input type.

impl From<SRem> for Constant

fn from(expr: SRem) -> Constant

Converts to this type from the input type.

impl From<Select> for Constant

fn from(expr: Select) -> Constant

Converts to this type from the input type.

impl From<Shl> for Constant

fn from(expr: Shl) -> Constant

Converts to this type from the input type.

impl From<ShuffleVector> for Constant

fn from(expr: ShuffleVector) -> Constant

Converts to this type from the input type.

impl From<Sub> for Constant

fn from(expr: Sub) -> Constant

Converts to this type from the input type.

impl From<Trunc> for Constant

fn from(expr: Trunc) -> Constant

Converts to this type from the input type.

impl From<UDiv> for Constant

fn from(expr: UDiv) -> Constant

Converts to this type from the input type.

impl From<UIToFP> for Constant

fn from(expr: UIToFP) -> Constant

Converts to this type from the input type.

impl From<URem> for Constant

fn from(expr: URem) -> Constant

Converts to this type from the input type.

impl From<Xor> for Constant

fn from(expr: Xor) -> Constant

Converts to this type from the input type.

impl From<ZExt> for Constant

fn from(expr: ZExt) -> Constant

Converts to this type from the input type.

impl PartialEq<Constant> for Constant

fn eq(&self, other: &Constant) -> 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 TryFrom<Constant> for AShr

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for Add

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for AddrSpaceCast

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for And

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for BitCast

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for ExtractElement

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for ExtractValue

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for FAdd

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for FCmp

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for FDiv

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for FMul

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for FPExt

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for FPToSI

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for FPToUI

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for FPTrunc

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for FRem

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for FSub

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for GetElementPtr

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for ICmp

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for InsertElement

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for InsertValue

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for IntToPtr

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for LShr

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for Mul

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for Or

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for PtrToInt

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for SDiv

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for SExt

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for SIToFP

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for SRem

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for Select

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for Shl

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for ShuffleVector

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for Sub

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for Trunc

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for UDiv

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for UIToFP

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for URem

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for Xor

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Constant> for ZExt

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(constant: Constant) -> Result<Self, Self::Error>

Performs the conversion.

impl Typed for Constant

fn get_type(&self, types: &Types) -> TypeRef

impl StructuralPartialEq for Constant