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>
impl<'ctx> PointerType<'ctx>
sourcepub unsafe fn new(ptr_type: LLVMTypeRef) -> Self
pub unsafe fn new(ptr_type: LLVMTypeRef) -> Self
Create PointerType
from LLVMTypeRef
§Safety
Undefined behavior, if referenced type isn’t pointer type
sourcepub fn size_of(self) -> IntValue<'ctx>
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();
#[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
let f32_ptr_type = context.ptr_type(AddressSpace::default());
let f32_ptr_type_size = f32_ptr_type.size_of();
sourcepub fn get_alignment(self) -> IntValue<'ctx>
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();
#[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
let f32_ptr_type = context.ptr_type(AddressSpace::default());
let f32_ptr_type_alignment = f32_ptr_type.get_alignment();
sourcepub fn ptr_type(self, address_space: AddressSpace) -> PointerType<'ctx>
👎Deprecated: Starting from version 15.0, LLVM doesn’t differentiate between pointer types. Use Context::ptr_type instead.
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();
#[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
let f32_ptr_type = context.ptr_type(AddressSpace::default());
let f32_ptr_ptr_type = f32_ptr_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!(f32_ptr_ptr_type.get_element_type().into_pointer_type(), f32_ptr_type);
sourcepub fn get_context(self) -> ContextRef<'ctx>
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();
#[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
let f32_ptr_type = context.ptr_type(AddressSpace::default());
assert_eq!(f32_ptr_type.get_context(), context);
sourcepub fn fn_type(
self,
param_types: &[BasicMetadataTypeEnum<'ctx>],
is_var_args: bool,
) -> FunctionType<'ctx>
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();
#[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
let f32_ptr_type = context.ptr_type(AddressSpace::default());
let fn_type = f32_ptr_type.fn_type(&[], false);
sourcepub fn array_type(self, size: u32) -> ArrayType<'ctx>
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();
#[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
let f32_ptr_type = context.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);
sourcepub fn get_address_space(self) -> AddressSpace
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();
#[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
let f32_ptr_type = context.ptr_type(AddressSpace::default());
assert_eq!(f32_ptr_type.get_address_space(), AddressSpace::default());
sourcepub fn print_to_string(self) -> LLVMString
pub fn print_to_string(self) -> LLVMString
Print the definition of a PointerType
to LLVMString
.
sourcepub fn const_null(self) -> PointerValue<'ctx>
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();
#[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
let f32_ptr_type = context.ptr_type(AddressSpace::default());
let f32_ptr_null = f32_ptr_type.const_null();
assert!(f32_ptr_null.is_null());
sourcepub fn const_zero(self) -> PointerValue<'ctx>
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();
#[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
let f32_ptr_type = context.ptr_type(AddressSpace::default());
let f32_ptr_zero = f32_ptr_type.const_zero();
sourcepub fn get_undef(self) -> PointerValue<'ctx>
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();
#[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
let f32_ptr_type = context.ptr_type(AddressSpace::default());
let f32_ptr_undef = f32_ptr_type.get_undef();
assert!(f32_ptr_undef.is_undef());
sourcepub fn get_poison(self) -> PointerValue<'ctx>
Available on crate features llvm12-0
or llvm13-0
or llvm14-0
or llvm15-0
or llvm16-0
or llvm17-0
or llvm18-0
only.
pub fn get_poison(self) -> PointerValue<'ctx>
llvm12-0
or llvm13-0
or llvm14-0
or llvm15-0
or llvm16-0
or llvm17-0
or llvm18-0
only.Creates a poison instance of a PointerType
.
§Example
use inkwell::context::Context;
use inkwell::AddressSpace;
use inkwell::values::AnyValue;
let context = Context::create();
let f32_type = context.f32_type();
#[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
let f32_ptr_type = context.ptr_type(AddressSpace::default());
let f32_ptr_undef = f32_ptr_type.get_poison();
assert!(f32_ptr_undef.is_poison());
sourcepub fn vec_type(self, size: u32) -> VectorType<'ctx>
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();
#[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
let f32_ptr_type = context.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);
sourcepub fn const_array(self, values: &[PointerValue<'ctx>]) -> ArrayValue<'ctx>
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();
#[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
let f32_ptr_type = context.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());
Trait Implementations§
source§impl<'ctx> AnyType<'ctx> for PointerType<'ctx>
impl<'ctx> AnyType<'ctx> for PointerType<'ctx>
source§fn as_any_type_enum(&self) -> AnyTypeEnum<'ctx>
fn as_any_type_enum(&self) -> AnyTypeEnum<'ctx>
AnyTypeEnum
that represents the current type.source§fn print_to_string(&self) -> LLVMString
fn print_to_string(&self) -> LLVMString
LLVMString
.source§impl AsTypeRef for PointerType<'_>
impl AsTypeRef for PointerType<'_>
source§fn as_type_ref(&self) -> LLVMTypeRef
fn as_type_ref(&self) -> LLVMTypeRef
source§impl<'ctx> BasicType<'ctx> for PointerType<'ctx>
impl<'ctx> BasicType<'ctx> for PointerType<'ctx>
source§fn as_basic_type_enum(&self) -> BasicTypeEnum<'ctx>
fn as_basic_type_enum(&self) -> BasicTypeEnum<'ctx>
BasicTypeEnum
that represents the current type.source§fn fn_type(
&self,
param_types: &[BasicMetadataTypeEnum<'ctx>],
is_var_args: bool,
) -> FunctionType<'ctx>
fn fn_type( &self, param_types: &[BasicMetadataTypeEnum<'ctx>], is_var_args: bool, ) -> FunctionType<'ctx>
source§fn is_sized(&self) -> bool
fn is_sized(&self) -> bool
BasicType
is sized or not.
For example, opaque structs are unsized. Read moresource§fn size_of(&self) -> Option<IntValue<'ctx>>
fn size_of(&self) -> Option<IntValue<'ctx>>
BasicType
. Value may vary depending on the target architecture. Read moresource§fn array_type(&self, size: u32) -> ArrayType<'ctx>
fn array_type(&self, size: u32) -> ArrayType<'ctx>
source§fn ptr_type(&self, address_space: AddressSpace) -> PointerType<'ctx>
fn ptr_type(&self, address_space: AddressSpace) -> PointerType<'ctx>
source§impl<'ctx> Clone for PointerType<'ctx>
impl<'ctx> Clone for PointerType<'ctx>
source§fn clone(&self) -> PointerType<'ctx>
fn clone(&self) -> PointerType<'ctx>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl<'ctx> Debug for PointerType<'ctx>
impl<'ctx> Debug for PointerType<'ctx>
source§impl Display for PointerType<'_>
impl Display for PointerType<'_>
source§impl<'ctx> From<PointerType<'ctx>> for AnyTypeEnum<'ctx>
impl<'ctx> From<PointerType<'ctx>> for AnyTypeEnum<'ctx>
source§fn from(value: PointerType<'_>) -> AnyTypeEnum<'_>
fn from(value: PointerType<'_>) -> AnyTypeEnum<'_>
source§impl<'ctx> From<PointerType<'ctx>> for BasicMetadataTypeEnum<'ctx>
impl<'ctx> From<PointerType<'ctx>> for BasicMetadataTypeEnum<'ctx>
source§fn from(value: PointerType<'_>) -> BasicMetadataTypeEnum<'_>
fn from(value: PointerType<'_>) -> BasicMetadataTypeEnum<'_>
source§impl<'ctx> From<PointerType<'ctx>> for BasicTypeEnum<'ctx>
impl<'ctx> From<PointerType<'ctx>> for BasicTypeEnum<'ctx>
source§fn from(value: PointerType<'_>) -> BasicTypeEnum<'_>
fn from(value: PointerType<'_>) -> BasicTypeEnum<'_>
source§impl<'ctx> PartialEq for PointerType<'ctx>
impl<'ctx> PartialEq for PointerType<'ctx>
source§impl<'ctx> PointerMathType<'ctx> for PointerType<'ctx>
impl<'ctx> PointerMathType<'ctx> for PointerType<'ctx>
source§type ValueType = PointerValue<'ctx>
type ValueType = PointerValue<'ctx>
source§type PtrConvType = IntType<'ctx>
type PtrConvType = IntType<'ctx>
source§impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for PointerType<'ctx>
impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for PointerType<'ctx>
source§impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for PointerType<'ctx>
impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for PointerType<'ctx>
source§impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for PointerType<'ctx>
impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for PointerType<'ctx>
impl<'ctx> Copy for PointerType<'ctx>
impl<'ctx> Eq for PointerType<'ctx>
impl<'ctx> StructuralPartialEq for PointerType<'ctx>
Auto Trait Implementations§
impl<'ctx> Freeze for PointerType<'ctx>
impl<'ctx> RefUnwindSafe for PointerType<'ctx>
impl<'ctx> !Send for PointerType<'ctx>
impl<'ctx> !Sync for PointerType<'ctx>
impl<'ctx> Unpin for PointerType<'ctx>
impl<'ctx> UnwindSafe for PointerType<'ctx>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more