Struct llvm_plugin_inkwell::values::IntValue

source · [−]

pub struct IntValue<'ctx> { /* private fields */ }

Implementations

impl<'ctx> IntValue<'ctx>

pub fn get_name(&self) -> &CStr

Gets the name of an IntValue. If the value is a constant, this will return an empty string.

pub fn set_name(&self, name: &str)

Set name of the IntValue.

pub fn get_type(self) -> IntType<'ctx>

pub fn is_null(self) -> bool

pub fn is_undef(self) -> bool

pub fn print_to_stderr(self)

pub fn as_instruction(self) -> Option<InstructionValue<'ctx>>

pub fn const_not(self) -> Self

pub fn const_neg(self) -> Self

pub fn const_nsw_neg(self) -> Self

pub fn const_nuw_neg(self) -> Self

pub fn const_add(self, rhs: IntValue<'ctx>) -> Self

pub fn const_nsw_add(self, rhs: IntValue<'ctx>) -> Self

pub fn const_nuw_add(self, rhs: IntValue<'ctx>) -> Self

pub fn const_sub(self, rhs: IntValue<'ctx>) -> Self

pub fn const_nsw_sub(self, rhs: IntValue<'ctx>) -> Self

pub fn const_nuw_sub(self, rhs: IntValue<'ctx>) -> Self

pub fn const_mul(self, rhs: IntValue<'ctx>) -> Self

pub fn const_nsw_mul(self, rhs: IntValue<'ctx>) -> Self

pub fn const_nuw_mul(self, rhs: IntValue<'ctx>) -> Self

pub fn const_unsigned_div(self, rhs: IntValue<'ctx>) -> Self

pub fn const_signed_div(self, rhs: IntValue<'ctx>) -> Self

pub fn const_exact_signed_div(self, rhs: IntValue<'ctx>) -> Self

pub fn const_exact_unsigned_div(self, rhs: IntValue<'ctx>) -> Self

pub fn const_unsigned_remainder(self, rhs: IntValue<'ctx>) -> Self

pub fn const_signed_remainder(self, rhs: IntValue<'ctx>) -> Self

pub fn const_and(self, rhs: IntValue<'ctx>) -> Self

pub fn const_or(self, rhs: IntValue<'ctx>) -> Self

pub fn const_xor(self, rhs: IntValue<'ctx>) -> Self

pub fn const_cast(self, int_type: IntType<'ctx>, is_signed: bool) -> Self

pub fn const_shl(self, rhs: IntValue<'ctx>) -> Self

pub fn const_rshr(self, rhs: IntValue<'ctx>) -> Self

pub fn const_ashr(self, rhs: IntValue<'ctx>) -> Self

pub fn const_unsigned_to_float(
self,
float_type: FloatType<'ctx>
) -> FloatValue<'ctx>

pub fn const_signed_to_float(
self,
float_type: FloatType<'ctx>
) -> FloatValue<'ctx>

pub fn const_to_pointer(self, ptr_type: PointerType<'ctx>) -> PointerValue<'ctx>

pub fn const_truncate(self, int_type: IntType<'ctx>) -> IntValue<'ctx>

pub fn const_s_extend(self, int_type: IntType<'ctx>) -> IntValue<'ctx>

pub fn const_z_ext(self, int_type: IntType<'ctx>) -> IntValue<'ctx>

pub fn const_truncate_or_bit_cast(
self,
int_type: IntType<'ctx>
) -> IntValue<'ctx>

pub fn const_s_extend_or_bit_cast(
self,
int_type: IntType<'ctx>
) -> IntValue<'ctx>

pub fn const_z_ext_or_bit_cast(self, int_type: IntType<'ctx>) -> IntValue<'ctx>

pub fn const_bit_cast(self, int_type: IntType<'_>) -> IntValue<'ctx>

pub fn const_int_compare(
    self,
    op: IntPredicate,
    rhs: IntValue<'ctx>
) -> IntValue<'ctx>

pub fn const_select<BV: BasicValue<'ctx>>(
    self,
    then: BV,
    else_: BV
) -> BasicValueEnum<'ctx>

pub fn is_const(self) -> bool

Determines whether or not an IntValue is an llvm::Constant.

Constants includes values that are not known at compile time, for example the address of a function casted to an integer.

Example

use inkwell::context::Context;

let context = Context::create();
let i64_type = context.i64_type();
let i64_val = i64_type.const_int(12, false);

assert!(i64_val.is_const());

pub fn is_constant_int(self) -> bool

Determines whether or not an IntValue is an llvm::ConstantInt.

ConstantInt only includes values that are known at compile time.

Example

use inkwell::context::Context;

let context = Context::create();
let i64_type = context.i64_type();
let i64_val = i64_type.const_int(12, false);

assert!(i64_val.is_constant_int());

pub fn get_zero_extended_constant(self) -> Option<u64>

Obtains a constant IntValue’s zero extended value.

Example

use inkwell::context::Context;

let context = Context::create();
let i8_type = context.i8_type();
let i8_all_ones = i8_type.const_all_ones();

assert_eq!(i8_all_ones.get_zero_extended_constant(), Some(255));

pub fn get_sign_extended_constant(self) -> Option<i64>

Obtains a constant IntValue’s sign extended value.

Example

use inkwell::context::Context;

let context = Context::create();
let i8_type = context.i8_type();
let i8_all_ones = i8_type.const_all_ones();

assert_eq!(i8_all_ones.get_sign_extended_constant(), Some(-1));

pub fn replace_all_uses_with(self, other: IntValue<'ctx>)

Trait Implementations

impl<'ctx> AnyValue<'ctx> for IntValue<'ctx>

fn as_any_value_enum(&self) -> AnyValueEnum<'ctx>

Returns an enum containing a typed version of AnyValue.

fn print_to_string(&self) -> LLVMString

Prints a value to a LLVMString

impl AsValueRef for IntValue<'_>

fn as_value_ref(&self) -> LLVMValueRef

impl<'ctx> BasicValue<'ctx> for IntValue<'ctx>

fn as_basic_value_enum(&self) -> BasicValueEnum<'ctx>

Returns an enum containing a typed version of the BasicValue.

fn as_instruction_value(&self) -> Option<InstructionValue<'ctx>>

Most BasicValues are the byproduct of an instruction and so are convertable into an InstructionValue Read more

fn get_first_use(&self) -> Option<BasicValueUse<'_>>

fn set_name(&self, name: &str)

Sets the name of a BasicValue. If the value is a constant, this is a noop.

impl<'ctx> Clone for IntValue<'ctx>

fn clone(&self) -> IntValue<'ctx>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl<'ctx> Debug for IntValue<'ctx>

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

Formats the value using the given formatter. Read more

impl Display for IntValue<'_>

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

Formats the value using the given formatter. Read more

impl<'ctx> From<IntValue<'ctx>> for AnyValueEnum<'ctx>

fn from(value: IntValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.

impl<'ctx> From<IntValue<'ctx>> for BasicMetadataValueEnum<'ctx>

fn from(value: IntValue<'_>) -> BasicMetadataValueEnum<'_>

Converts to this type from the input type.

impl<'ctx> From<IntValue<'ctx>> for BasicValueEnum<'ctx>

fn from(value: IntValue<'_>) -> BasicValueEnum<'_>

Converts to this type from the input type.

impl<'ctx> Hash for IntValue<'ctx>

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

impl<'ctx> IntMathValue<'ctx> for IntValue<'ctx>

type BaseType = IntType<'ctx>

fn new(value: LLVMValueRef) -> Self

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for IntValue<'ctx>

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

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

1.0.0 · source

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. Read more

impl<'ctx> PartialEq<BasicMetadataValueEnum<'ctx>> for IntValue<'ctx>

fn eq(&self, other: &BasicMetadataValueEnum<'ctx>) -> bool

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

1.0.0 · source

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. Read more

impl<'ctx> PartialEq<BasicValueEnum<'ctx>> for IntValue<'ctx>

fn eq(&self, other: &BasicValueEnum<'ctx>) -> bool

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

1.0.0 · source

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. Read more

impl<'ctx> PartialEq<IntValue<'ctx>> for AnyValueEnum<'ctx>

fn eq(&self, other: &IntValue<'ctx>) -> bool

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

1.0.0 · source

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. Read more

impl<'ctx> PartialEq<IntValue<'ctx>> for BasicMetadataValueEnum<'ctx>

fn eq(&self, other: &IntValue<'ctx>) -> bool

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

1.0.0 · source

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. Read more

impl<'ctx> PartialEq<IntValue<'ctx>> for BasicValueEnum<'ctx>

fn eq(&self, other: &IntValue<'ctx>) -> bool

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

1.0.0 · source

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. Read more

impl<'ctx> PartialEq<IntValue<'ctx>> for IntValue<'ctx>

fn eq(&self, other: &IntValue<'ctx>) -> bool

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

1.0.0 · source

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. Read more

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for IntValue<'ctx>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for IntValue<'ctx>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: BasicMetadataValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'ctx> TryFrom<BasicValueEnum<'ctx>> for IntValue<'ctx>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: BasicValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'ctx> TryFrom<InstructionValue<'ctx>> for IntValue<'ctx>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: InstructionValue<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'ctx> Copy for IntValue<'ctx>

impl<'ctx> Eq for IntValue<'ctx>

impl<'ctx> StructuralEq for IntValue<'ctx>

impl<'ctx> StructuralPartialEq for IntValue<'ctx>

Auto Trait Implementations

impl<'ctx> RefUnwindSafe for IntValue<'ctx>

impl<'ctx> !Send for IntValue<'ctx>

impl<'ctx> !Sync for IntValue<'ctx>

impl<'ctx> Unpin for IntValue<'ctx>

impl<'ctx> UnwindSafe for IntValue<'ctx>

Blanket Implementations

impl<T> Any for Twhere
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for Twhere
T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.