inkwell::values

Struct ArrayValue

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

An ArrayValue is a block of contiguous constants or variables.

Implementations§

source§

impl<'ctx> ArrayValue<'ctx>

source

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

Get a value from an LLVMValueRef.

§Safety

The ref must be valid and of type array.

source

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.

source

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.

source

pub fn get_name(&self) -> &CStr

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

source

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

Set name of the ArrayValue.

source

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

Gets the type of this ArrayValue.

source

pub fn is_null(self) -> bool

Determines whether or not this value is null.

source

pub fn is_undef(self) -> bool

Determines whether or not this value is undefined.

source

pub fn print_to_stderr(self)

Prints this ArrayValue to standard error.

source

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

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

source

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.

source

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

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

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§

source§

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

source§

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

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

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

source§

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

source§

fn clone(&self) -> ArrayValue<'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 Debug for ArrayValue<'_>

source§

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

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

impl Display for ArrayValue<'_>

source§

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

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

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

type Error = ()

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

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

Performs the conversion.
source§

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

source§

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

source§

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

Auto Trait Implementations§

§

impl<'ctx> Freeze for ArrayValue<'ctx>

§

impl<'ctx> RefUnwindSafe for ArrayValue<'ctx>

§

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

§

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

§

impl<'ctx> Unpin for ArrayValue<'ctx>

§

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