Struct inkwell::values::PointerValue

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

Implementations

impl<'ctx> PointerValue<'ctx>

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

Get a value from an LLVMValueRef.

Safety

The ref must be valid and of type pointer.

pub fn get_name(&self) -> &CStr

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

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

Set name of the PointerValue.

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

pub fn is_null(self) -> bool

pub fn is_undef(self) -> bool

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

pub fn print_to_stderr(self)

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

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

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.

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

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.

impl<'ctx> PointerValue<'ctx>

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

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

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

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

Trait Implementations

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

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

Returns an enum containing a typed version of AnyValue.

fn print_to_string(&self) -> LLVMString

Prints a value to a LLVMString

fn is_poison(&self) -> bool

Returns whether the value is poison

impl AsValueRef for PointerValue<'_>

fn as_value_ref(&self) -> LLVMValueRef

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

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

Returns an enum containing a typed version of the BasicValue.

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

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

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

fn set_name(&self, name: &str)

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

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

fn clone(&self) -> PointerValue<'ctx>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'ctx> Debug for PointerValue<'ctx>

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

Formats the value using the given formatter.

impl Display for PointerValue<'_>

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

type BaseType = IntType<'ctx>

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

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

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'ctx> PointerMathValue<'ctx> for PointerValue<'ctx>

type BaseType = PointerType<'ctx>

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

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

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

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