Struct 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();
#[cfg(feature = "typed-pointers")]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(not(feature = "typed-pointers"))]
let f32_ptr_type = context.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();
#[cfg(feature = "typed-pointers")]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(not(feature = "typed-pointers"))]
let f32_ptr_type = context.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>

👎Deprecated: Starting from version 15.0, LLVM doesn’t differentiate between pointer types. Use Context::ptr_type instead.

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(feature = "typed-pointers")]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(not(feature = "typed-pointers"))]
let f32_ptr_type = context.ptr_type(AddressSpace::default());
let f32_ptr_ptr_type = f32_ptr_type.ptr_type(AddressSpace::default());

#[cfg(feature = "typed-pointers")]
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();
#[cfg(feature = "typed-pointers")]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(not(feature = "typed-pointers"))]
let f32_ptr_type = context.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();
#[cfg(feature = "typed-pointers")]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(not(feature = "typed-pointers"))]
let f32_ptr_type = context.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();
#[cfg(feature = "typed-pointers")]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(not(feature = "typed-pointers"))]
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);
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();
#[cfg(feature = "typed-pointers")]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(not(feature = "typed-pointers"))]
let f32_ptr_type = context.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();
#[cfg(feature = "typed-pointers")]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(not(feature = "typed-pointers"))]
let f32_ptr_type = context.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();
#[cfg(feature = "typed-pointers")]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(not(feature = "typed-pointers"))]
let f32_ptr_type = context.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();
#[cfg(feature = "typed-pointers")]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(not(feature = "typed-pointers"))]
let f32_ptr_type = context.ptr_type(AddressSpace::default());
let f32_ptr_undef = f32_ptr_type.get_undef();

assert!(f32_ptr_undef.is_undef());
Source

pub 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.

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(feature = "typed-pointers")]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(not(feature = "typed-pointers"))]
let f32_ptr_type = context.ptr_type(AddressSpace::default());
let f32_ptr_undef = f32_ptr_type.get_poison();

assert!(f32_ptr_undef.is_poison());
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();
#[cfg(feature = "typed-pointers")]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(not(feature = "typed-pointers"))]
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);
Source

pub fn scalable_vec_type(self, size: u32) -> ScalableVectorType<'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.

Creates a ScalableVectorType 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(feature = "typed-pointers")]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(not(feature = "typed-pointers"))]
let f32_ptr_type = context.ptr_type(AddressSpace::default());
let f32_ptr_scalable_vec_type = f32_ptr_type.scalable_vec_type(3);

assert_eq!(f32_ptr_scalable_vec_type.get_size(), 3);
assert_eq!(f32_ptr_scalable_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();
#[cfg(feature = "typed-pointers")]
let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
#[cfg(not(feature = "typed-pointers"))]
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());
Source

pub fn is_opaque(self) -> bool

Available on crate features llvm15-0 or llvm16-0 or llvm17-0 or llvm18-0 only.

Determine whether this pointer is opaque.

Trait Implementations§

Source§

impl<'ctx> AnyType<'ctx> for PointerType<'ctx>

Source§

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

Returns an AnyTypeEnum that represents the current type.
Source§

fn print_to_string(&self) -> LLVMString

Prints the definition of a Type to a LLVMString.
Source§

impl AsTypeRef for PointerType<'_>

Source§

fn as_type_ref(&self) -> LLVMTypeRef

Returns the internal LLVM reference behind the type
Source§

impl<'ctx> BasicType<'ctx> for PointerType<'ctx>

Source§

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

Returns a BasicTypeEnum that represents the current type.
Source§

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

Create a FunctionType with this BasicType as its return type. Read more
Source§

fn is_sized(&self) -> bool

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

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

Gets the size of this BasicType. Value may vary depending on the target architecture. Read more
Source§

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

Create an ArrayType with this BasicType as its elements. Read more
Source§

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.
Create a PointerType that points to this BasicType. Read more
Source§

impl<'ctx> Clone for PointerType<'ctx>

Source§

fn clone(&self) -> PointerType<'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
Source§

impl<'ctx> Debug for PointerType<'ctx>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for PointerType<'_>

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

impl<'ctx> PartialEq for PointerType<'ctx>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<'ctx> PointerMathType<'ctx> for PointerType<'ctx>

Source§

type ValueType = PointerValue<'ctx>

The value instance of a pointer type.
Source§

type PtrConvType = IntType<'ctx>

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

impl<'ctx> TryFrom<AnyTypeEnum<'ctx>> for PointerType<'ctx>

Source§

type Error = ()

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = ()

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = ()

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<'ctx> Copy for PointerType<'ctx>

Source§

impl<'ctx> Eq for PointerType<'ctx>

Source§

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> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.