inkwell::values

Struct PointerValue

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

Implementations§

source§

impl<'ctx> PointerValue<'ctx>

source

pub unsafe fn new(value: LLVMValueRef) -> Self

Get a value from an LLVMValueRef.

§Safety

The ref must be valid and of type pointer.

source

pub fn get_name(&self) -> &CStr

Get name of the PointerValue. If the value is a constant, this will return an empty string.

source

pub fn set_name(&self, name: &str)

Set name of the PointerValue.

source

pub fn get_type(self) -> PointerType<'ctx>

source

pub fn is_null(self) -> bool

source

pub fn is_undef(self) -> bool

source

pub fn is_const(self) -> bool

Determines whether or not a PointerValue is a constant.

§Example
use inkwell::AddressSpace;
use inkwell::context::Context;

let context = Context::create();
let void_type = context.void_type();
source

pub fn print_to_stderr(self)

source

pub fn as_instruction(self) -> Option<InstructionValue<'ctx>>

source

pub unsafe fn const_gep<T: BasicType<'ctx>>( self, ty: T, ordered_indexes: &[IntValue<'ctx>], ) -> PointerValue<'ctx>

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

GEP is very likely to segfault if indexes are used incorrectly, and is therefore an unsafe function. Maybe we can change this in the future.

source

pub unsafe fn const_in_bounds_gep<T: BasicType<'ctx>>( self, ty: T, ordered_indexes: &[IntValue<'ctx>], ) -> PointerValue<'ctx>

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

GEP is very likely to segfault if indexes are used incorrectly, and is therefore an unsafe function. Maybe we can change this in the future.

source§

impl<'ctx> PointerValue<'ctx>

source

pub fn const_to_int(self, int_type: IntType<'ctx>) -> IntValue<'ctx>

source

pub fn const_cast(self, ptr_type: PointerType<'ctx>) -> PointerValue<'ctx>

source

pub fn const_address_space_cast( self, ptr_type: PointerType<'ctx>, ) -> PointerValue<'ctx>

source

pub fn replace_all_uses_with(self, other: PointerValue<'ctx>)

Trait Implementations§

source§

impl<'ctx> AnyValue<'ctx> for PointerValue<'ctx>

source§

fn as_any_value_enum(&self) -> AnyValueEnum<'ctx>

Returns an enum containing a typed version of AnyValue.
source§

fn print_to_string(&self) -> LLVMString

Prints a value to a LLVMString
source§

fn is_poison(&self) -> bool

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.
Returns whether the value is poison
source§

impl AsValueRef for PointerValue<'_>

source§

impl<'ctx> BasicValue<'ctx> for PointerValue<'ctx>

source§

fn as_basic_value_enum(&self) -> BasicValueEnum<'ctx>

Returns an enum containing a typed version of the BasicValue.
source§

fn as_instruction_value(&self) -> Option<InstructionValue<'ctx>>

Most BasicValues are the byproduct of an instruction and so are convertible into an InstructionValue
source§

fn get_first_use(&self) -> Option<BasicValueUse<'_>>

source§

fn set_name(&self, name: &str)

Sets the name of a BasicValue. If the value is a constant, this is a noop.
source§

impl<'ctx> Clone for PointerValue<'ctx>

source§

fn clone(&self) -> PointerValue<'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 PointerValue<'ctx>

source§

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

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

impl Display for PointerValue<'_>

source§

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

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

impl<'ctx> From<PointerValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn from(value: PointerValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<PointerValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn from(value: PointerValue<'_>) -> BasicMetadataValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> From<PointerValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn from(value: PointerValue<'_>) -> BasicValueEnum<'_>

Converts to this type from the input type.
source§

impl<'ctx> Hash for PointerValue<'ctx>

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<'ctx> IntMathValue<'ctx> for PointerValue<'ctx>

source§

type BaseType = IntType<'ctx>

source§

unsafe fn new(value: LLVMValueRef) -> PointerValue<'ctx>

source§

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for PointerValue<'ctx>

source§

fn eq(&self, other: &AnyValueEnum<'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> PartialEq<BasicMetadataValueEnum<'ctx>> for PointerValue<'ctx>

source§

fn eq(&self, other: &BasicMetadataValueEnum<'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> PartialEq<BasicValueEnum<'ctx>> for PointerValue<'ctx>

source§

fn eq(&self, other: &BasicValueEnum<'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> PartialEq<PointerValue<'ctx>> for AnyValueEnum<'ctx>

source§

fn eq(&self, other: &PointerValue<'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> PartialEq<PointerValue<'ctx>> for BasicMetadataValueEnum<'ctx>

source§

fn eq(&self, other: &PointerValue<'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> PartialEq<PointerValue<'ctx>> for BasicValueEnum<'ctx>

source§

fn eq(&self, other: &PointerValue<'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> PartialEq for PointerValue<'ctx>

source§

fn eq(&self, other: &PointerValue<'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> PointerMathValue<'ctx> for PointerValue<'ctx>

source§

type BaseType = PointerType<'ctx>

source§

unsafe fn new(value: LLVMValueRef) -> PointerValue<'ctx>

source§

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for PointerValue<'ctx>

source§

type Error = ()

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

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

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicMetadataValueEnum<'ctx>> for PointerValue<'ctx>

source§

type Error = ()

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

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

Performs the conversion.
source§

impl<'ctx> TryFrom<BasicValueEnum<'ctx>> for PointerValue<'ctx>

source§

type Error = ()

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

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

Performs the conversion.
source§

impl<'ctx> TryFrom<InstructionValue<'ctx>> for PointerValue<'ctx>

source§

type Error = ()

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

fn try_from(value: InstructionValue<'_>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<'ctx> Copy for PointerValue<'ctx>

source§

impl<'ctx> Eq for PointerValue<'ctx>

source§

impl<'ctx> StructuralPartialEq for PointerValue<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for PointerValue<'ctx>

§

impl<'ctx> RefUnwindSafe for PointerValue<'ctx>

§

impl<'ctx> !Send for PointerValue<'ctx>

§

impl<'ctx> !Sync for PointerValue<'ctx>

§

impl<'ctx> Unpin for PointerValue<'ctx>

§

impl<'ctx> UnwindSafe for PointerValue<'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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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§

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