Struct inkwell::types::ArrayType

source ·

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

Expand description

An ArrayType is the type of contiguous constants or variables.

Implementations§

source §

impl<'ctx> ArrayType<'ctx>

source

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

Create ArrayType from LLVMTypeRef

Safety

Undefined behavior, if referenced type isn’t array type

source

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

Gets the size of this ArrayType. 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_array_type = i8_type.array_type(3);
let i8_array_type_size = i8_array_type.size_of();

source

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

Gets the alignment of this ArrayType. 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_array_type = i8_type.array_type(3);
let i8_array_type_alignment = i8_array_type.get_alignment();

source

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

Creates a PointerType with this ArrayType for its element type.

Example

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

let context = Context::create();
let i8_type = context.i8_type();
let i8_array_type = i8_type.array_type(3);
let i8_array_ptr_type = i8_array_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_array_ptr_type.get_element_type().into_array_type(), i8_array_type);

source

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

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

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.get_context(), context);

source

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

Creates a FunctionType with this ArrayType for its return 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);
let fn_type = i8_array_type.fn_type(&[], false);

source

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

Creates an ArrayType with this ArrayType 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);
let i8_array_array_type = i8_array_type.array_type(3);

assert_eq!(i8_array_array_type.len(), 3);
assert_eq!(i8_array_array_type.get_element_type().into_array_type(), i8_array_type);

source

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

Creates a constant ArrayValue.

Example

use inkwell::context::Context;

let context = Context::create();
let f32_type = context.f32_type();
let f32_array_type = f32_type.array_type(3);
let f32_array_val = f32_array_type.const_zero();
let f32_array_array = f32_array_type.const_array(&[f32_array_val, f32_array_val]);

assert!(f32_array_array.is_const());

source

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

Creates a constant zero value of this ArrayType.

Example

use inkwell::context::Context;

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

source

pub fn len(self) -> u32

Gets the length of this ArrayType.

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);

source

pub fn print_to_string(self) -> LLVMString

Print the definition of an ArrayType to LLVMString

source

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

Creates an undefined instance of a ArrayType.

Example

use inkwell::context::Context;

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

assert!(i8_array_undef.is_undef());

source

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

Available on crate features llvm12-0 or llvm13-0 or llvm14-0 or llvm15-0 or llvm16-0 only.

Creates a poison instance of a ArrayType.

Example

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

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

assert!(i8_array_poison.is_poison());

source

pub fn get_element_type(self) -> BasicTypeEnum<'ctx>

Gets the element type of this ArrayType.

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.get_element_type().into_int_type(), i8_type);