Struct llvm_plugin_inkwell::types::PointerType

source ·

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

Expand description

A PointerType is the type of a pointer constant or variable.

Implementations§

source §

impl<'ctx> PointerType<'ctx>

source

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

Create PointerType from LLVMTypeRef

Safety

Undefined behavior, if referenced type isn’t pointer type

source

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

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

Example

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

let context = Context::create();
let f32_type = context.f32_type();
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
let f32_ptr_type_size = f32_ptr_type.size_of();

source

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

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

Example

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

let context = Context::create();
let f32_type = context.f32_type();
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
let f32_ptr_type_alignment = f32_ptr_type.get_alignment();

source

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

Creates a PointerType with this PointerType for its element type.

Example

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

let context = Context::create();
let f32_type = context.f32_type();
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
let f32_ptr_ptr_type = f32_ptr_type.ptr_type(AddressSpace::default());

#[cfg(not(feature = "llvm15-0"))]
assert_eq!(f32_ptr_ptr_type.get_element_type().into_pointer_type(), f32_ptr_type);

source

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

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

Example

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

let context = Context::create();
let f32_type = context.f32_type();
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());

assert_eq!(f32_ptr_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 PointerType for its return type.

Example

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

let context = Context::create();
let f32_type = context.f32_type();
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
let fn_type = f32_ptr_type.fn_type(&[], false);

source

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

Creates an ArrayType with this PointerType for its element type.

Example

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

let context = Context::create();
let f32_type = context.f32_type();
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
let f32_ptr_array_type = f32_ptr_type.array_type(3);

assert_eq!(f32_ptr_array_type.len(), 3);
assert_eq!(f32_ptr_array_type.get_element_type().into_pointer_type(), f32_ptr_type);

source

pub fn get_address_space(self) -> AddressSpace

Gets the AddressSpace a PointerType was created with.

Example

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

let context = Context::create();
let f32_type = context.f32_type();
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());

assert_eq!(f32_ptr_type.get_address_space(), AddressSpace::default());

source

pub fn print_to_string(self) -> LLVMString

Print the definition of a PointerType to LLVMString.

source

pub fn const_null(self) -> PointerValue<'ctx>

Creates a null PointerValue of this PointerType. It will be automatically assigned this PointerType’s Context.

Example

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

// Local Context
let context = Context::create();
let f32_type = context.f32_type();
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
let f32_ptr_null = f32_ptr_type.const_null();

assert!(f32_ptr_null.is_null());

source

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

Creates a constant null value of this PointerType. This is practically the same as calling const_null for this particular type and so this function may be removed in the future.

Example

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

let context = Context::create();
let f32_type = context.f32_type();
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
let f32_ptr_zero = f32_ptr_type.const_zero();

source

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

Creates an undefined instance of a PointerType.

Example

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

let context = Context::create();
let f32_type = context.f32_type();
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
let f32_ptr_undef = f32_ptr_type.get_undef();

assert!(f32_ptr_undef.is_undef());

source

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

Creates a VectorType with this PointerType for its element type.

Example

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

let context = Context::create();
let f32_type = context.f32_type();
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
let f32_ptr_vec_type = f32_ptr_type.vec_type(3);

assert_eq!(f32_ptr_vec_type.get_size(), 3);
assert_eq!(f32_ptr_vec_type.get_element_type().into_pointer_type(), f32_ptr_type);

source

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

Creates a constant ArrayValue.

Example

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

let context = Context::create();
let f32_type = context.f32_type();
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
let f32_ptr_val = f32_ptr_type.const_null();
let f32_ptr_array = f32_ptr_type.const_array(&[f32_ptr_val, f32_ptr_val]);

assert!(f32_ptr_array.is_const());