Struct inkwell::values::ArrayValue

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

An ArrayValue is a block of contiguous constants or variables.

Implementations

impl<'ctx> ArrayValue<'ctx>

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

Get a value from an LLVMValueRef.

Safety

The ref must be valid and of type array.

pub unsafe fn new_const_array<T: AsTypeRef, V: AsValueRef>( ty: &T, values: &[V], ) -> Self

Creates a new constant ArrayValue with the given type and values.

Safety

values must be of the same type as ty.

pub unsafe fn new_raw_const_array( ty: LLVMTypeRef, values: &[LLVMValueRef], ) -> Self

Creates a new constant ArrayValue with the given type and values.

Safety

values must be of the same type as ty.

pub fn get_name(&self) -> &CStr

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

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

Set name of the ArrayValue.

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

Gets the type of this ArrayValue.

pub fn is_null(self) -> bool

Determines whether or not this value is null.

pub fn is_undef(self) -> bool

Determines whether or not this value is undefined.

pub fn print_to_stderr(self)

Prints this ArrayValue to standard error.

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

Attempt to convert this ArrayValue to an InstructionValue, if possible.

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

Replaces all uses of this value with another value of the same type. If used incorrectly this may result in invalid IR.

pub fn is_const(self) -> bool

Determines whether or not an ArrayValue is a constant.

Example

use inkwell::context::Context;

let context = Context::create();
let i64_type = context.i64_type();
let i64_val = i64_type.const_int(23, false);
let array_val = i64_type.const_array(&[i64_val]);

assert!(array_val.is_const());

pub fn is_const_string(self) -> bool

Determines whether or not an ArrayValue represents a constant array of i8s.

Example

use inkwell::context::Context;

let context = Context::create();
let string = context.const_string(b"my_string", false);

assert!(string.is_const_string());

pub fn get_string_constant(&self) -> Option<&CStr>

Obtain the string from the ArrayValue if the value points to a constant string.

Example

use inkwell::context::Context;
use std::ffi::CStr;

let context = Context::create();
let string = context.const_string(b"hello!", true);

let result = CStr::from_bytes_with_nul(b"hello!\0").unwrap();
assert_eq!(string.get_string_constant(), Some(result));

Trait Implementations

impl<'ctx> AggregateValue<'ctx> for ArrayValue<'ctx>

fn as_aggregate_value_enum(&self) -> AggregateValueEnum<'ctx>

Returns an enum containing a typed version of the AggregateValue.

impl<'ctx> AnyValue<'ctx> for ArrayValue<'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 ArrayValue<'_>

fn as_value_ref(&self) -> LLVMValueRef

impl<'ctx> BasicValue<'ctx> for ArrayValue<'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 ArrayValue<'ctx>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ArrayValue<'_>

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

Formats the value using the given formatter.

impl Display for ArrayValue<'_>

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

Formats the value using the given formatter.

impl<'ctx> From<ArrayValue<'ctx>> for AggregateValueEnum<'ctx>

fn from(value: ArrayValue<'_>) -> AggregateValueEnum<'_>

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<'ctx> Hash for ArrayValue<'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> PartialEq<AggregateValueEnum<'ctx>> for ArrayValue<'ctx>

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

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

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

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

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

fn eq(&self, other: &ArrayValue<'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> TryFrom<AggregateValueEnum<'ctx>> for ArrayValue<'ctx>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for ArrayValue<'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 ArrayValue<'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 ArrayValue<'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> Copy for ArrayValue<'ctx>

impl<'ctx> Eq for ArrayValue<'ctx>

impl<'ctx> StructuralPartialEq for ArrayValue<'ctx>