Struct inkwell::types::IntType

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

An IntType is the type of an integer constant or variable.

Implementations

impl<'ctx> IntType<'ctx>

pub unsafe fn new(int_type: LLVMTypeRef) -> Self

Create IntType from LLVMTypeRef

Safety

Undefined behavior, if referenced type isn’t int type

pub fn const_int(self, value: u64, sign_extend: bool) -> IntValue<'ctx>

Creates an IntValue representing a constant value of this IntType. It will be automatically assigned this IntType’s Context.

Example

use inkwell::context::Context;

// Local Context
let context = Context::create();
let i32_type = context.i32_type();
let i32_value = i32_type.const_int(42, false);

pub fn const_int_from_string( self, slice: &str, radix: StringRadix ) -> Option<IntValue<'ctx>>

Create an IntValue from a string and radix. LLVM provides no error handling here, so this may produce unexpected results and should not be relied upon for validation.

Example

use std::convert::TryFrom;

use inkwell::context::Context;
use inkwell::types::StringRadix;
use inkwell::values::AnyValue;

let context = Context::create();
let i8_type = context.i8_type();
let i8_val = i8_type.const_int_from_string("0121", StringRadix::Decimal).unwrap();

assert_eq!(i8_val.print_to_string().to_string(), "i8 121");

let i8_val = i8_type.const_int_from_string("0121", StringRadix::try_from(10).unwrap()).unwrap();

assert_eq!(i8_val.print_to_string().to_string(), "i8 16");

let i8_val = i8_type.const_int_from_string("0121", StringRadix::Binary);
assert!(i8_val.is_none());

let i8_val = i8_type.const_int_from_string("ABCD", StringRadix::Binary);
assert!(i8_val.is_none());

pub fn const_int_arbitrary_precision(self, words: &[u64]) -> IntValue<'ctx>

Create a constant IntValue of arbitrary precision.

Example

use inkwell::context::Context;

let context = Context::create();
let i64_type = context.i64_type();
let i64_val = i64_type.const_int_arbitrary_precision(&[1, 2]);

pub fn const_all_ones(self) -> IntValue<'ctx>

Creates an IntValue representing a constant value of all one bits of this IntType. It will be automatically assigned this IntType’s Context.

Example

use inkwell::context::Context;

// Local Context
let context = Context::create();
let i32_type = context.i32_type();
let i32_ptr_value = i32_type.const_all_ones();

pub fn const_zero(self) -> IntValue<'ctx>

Creates a constant zero value of this IntType.

Example

use inkwell::context::Context;
use inkwell::values::AnyValue;

let context = Context::create();
let i8_type = context.i8_type();
let i8_zero = i8_type.const_zero();

assert_eq!(i8_zero.print_to_string().to_string(), "i8 0");

pub fn fn_type( self, param_types: &[BasicMetadataTypeEnum<'ctx>], is_var_args: bool ) -> FunctionType<'ctx>

Creates a FunctionType with this IntType for its return type.

Example

use inkwell::context::Context;

let context = Context::create();
let i8_type = context.i8_type();
let fn_type = i8_type.fn_type(&[], false);

pub fn array_type(self, size: u32) -> ArrayType<'ctx>

Creates an ArrayType with this IntType for its element type.

Example

use inkwell::context::Context;

let context = Context::create();
let i8_type = context.i8_type();
let i8_array_type = i8_type.array_type(3);

assert_eq!(i8_array_type.len(), 3);
assert_eq!(i8_array_type.get_element_type().into_int_type(), i8_type);

pub fn vec_type(self, size: u32) -> VectorType<'ctx>

Creates a VectorType with this IntType for its element type.

Example

use inkwell::context::Context;

let context = Context::create();
let i8_type = context.i8_type();
let i8_vector_type = i8_type.vec_type(3);

assert_eq!(i8_vector_type.get_size(), 3);
assert_eq!(i8_vector_type.get_element_type().into_int_type(), i8_type);

pub fn get_context(self) -> ContextRef<'ctx>

Gets a reference to the Context this IntType was created in.

Example

use inkwell::context::Context;

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

assert_eq!(i8_type.get_context(), context);

pub fn size_of(self) -> IntValue<'ctx>

Gets the size of this IntType. Value may vary depending on the target architecture.

Example

use inkwell::context::Context;

let context = Context::create();
let i8_type = context.i8_type();
let i8_type_size = i8_type.size_of();

pub fn get_alignment(self) -> IntValue<'ctx>

Gets the alignment of this IntType. Value may vary depending on the target architecture.

Example

use inkwell::context::Context;

let context = Context::create();
let i8_type = context.i8_type();
let i8_type_alignment = i8_type.get_alignment();

pub fn ptr_type(self, address_space: AddressSpace) -> PointerType<'ctx>

Creates a PointerType with this IntType for its element type.

Example

use inkwell::context::Context;
use inkwell::AddressSpace;

let context = Context::create();
let i8_type = context.i8_type();
let i8_ptr_type = i8_type.ptr_type(AddressSpace::default());

#[cfg(any(
    feature = "llvm4-0",
    feature = "llvm5-0",
    feature = "llvm6-0",
    feature = "llvm7-0",
    feature = "llvm8-0",
    feature = "llvm9-0",
    feature = "llvm10-0",
    feature = "llvm11-0",
    feature = "llvm12-0",
    feature = "llvm13-0",
    feature = "llvm14-0"
))]
assert_eq!(i8_ptr_type.get_element_type().into_int_type(), i8_type);

pub fn get_bit_width(self) -> u32

Gets the bit width of an IntType.

Example

use inkwell::context::Context;

let context = Context::create();
let bool_type = context.bool_type();

assert_eq!(bool_type.get_bit_width(), 1);

pub fn print_to_string(self) -> LLVMString

Print the definition of an IntType to LLVMString.

pub fn get_undef(self) -> IntValue<'ctx>

Creates an undefined instance of an IntType.

Example

use inkwell::context::Context;
use inkwell::AddressSpace;

let context = Context::create();
let i8_type = context.i8_type();
let i8_undef = i8_type.get_undef();

assert!(i8_undef.is_undef());

pub fn get_poison(self) -> IntValue<'ctx>

Creates a poison instance of an IntType.

Example

use inkwell::context::Context;
use inkwell::AddressSpace;
use inkwell::values::AnyValue;

let context = Context::create();
let i8_type = context.i8_type();
let i8_poison = i8_type.get_poison();

assert!(i8_poison.is_poison());

pub fn create_generic_value( self, value: u64, is_signed: bool ) -> GenericValue<'ctx>

Creates a GenericValue for use with ExecutionEngines.

pub fn const_array(self, values: &[IntValue<'ctx>]) -> ArrayValue<'ctx>

Creates a constant ArrayValue.

Example

use inkwell::context::Context;

let context = Context::create();
let i8_type = context.i8_type();
let i8_val = i8_type.const_int(0, false);
let i8_val2 = i8_type.const_int(2, false);
let i8_array = i8_type.const_array(&[i8_val, i8_val2]);

assert!(i8_array.is_const());

Trait Implementations

impl<'ctx> AnyType<'ctx> for IntType<'ctx>

fn as_any_type_enum(&self) -> AnyTypeEnum<'ctx>

Returns an AnyTypeEnum that represents the current type.

fn print_to_string(&self) -> LLVMString

Prints the definition of a Type to a LLVMString.

impl AsTypeRef for IntType<'_>

fn as_type_ref(&self) -> LLVMTypeRef

Returns the internal LLVM reference behind the type

impl<'ctx> BasicType<'ctx> for IntType<'ctx>

fn as_basic_type_enum(&self) -> BasicTypeEnum<'ctx>

Returns a BasicTypeEnum that represents the current type.

fn fn_type( &self, param_types: &[BasicMetadataTypeEnum<'ctx>], is_var_args: bool ) -> FunctionType<'ctx>

Create a FunctionType with this BasicType as its return type.

fn is_sized(&self) -> bool

Determines whether or not this BasicType is sized or not. For example, opaque structs are unsized.

fn size_of(&self) -> Option<IntValue<'ctx>>

Gets the size of this BasicType. Value may vary depending on the target architecture.

fn array_type(&self, size: u32) -> ArrayType<'ctx>

Create an ArrayType with this BasicType as its elements.

fn ptr_type(&self, address_space: AddressSpace) -> PointerType<'ctx>

Create a PointerType that points to this BasicType.

impl<'ctx> Clone for IntType<'ctx>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'ctx> Debug for IntType<'ctx>

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

Formats the value using the given formatter.

impl Display for IntType<'_>

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

Formats the value using the given formatter.

impl<'ctx> From<IntType<'ctx>> for AnyTypeEnum<'ctx>

fn from(value: IntType<'_>) -> AnyTypeEnum<'_>

Converts to this type from the input type.

impl<'ctx> From<IntType<'ctx>> for BasicMetadataTypeEnum<'ctx>

fn from(value: IntType<'_>) -> BasicMetadataTypeEnum<'_>

Converts to this type from the input type.

impl<'ctx> From<IntType<'ctx>> for BasicTypeEnum<'ctx>

fn from(value: IntType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.

impl<'ctx> IntMathType<'ctx> for IntType<'ctx>

type ValueType = IntValue<'ctx>

The value instance of an int or int vector type.

type MathConvType = FloatType<'ctx>

The type for int to float or int vector to float vector conversions.

type PtrConvType = PointerType<'ctx>

The type for int to pointer or int vector to pointer vector conversions.

impl<'ctx> PartialEq for IntType<'ctx>

fn eq(&self, other: &IntType<'ctx>) -> 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<'ctx> TryFrom<AnyTypeEnum<'ctx>> for IntType<'ctx>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for IntType<'ctx>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for IntType<'ctx>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'ctx> Copy for IntType<'ctx>

impl<'ctx> Eq for IntType<'ctx>

impl<'ctx> StructuralPartialEq for IntType<'ctx>