inkwell::values

Struct StructValue

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

Implementations§

source§

impl<'ctx> StructValue<'ctx>

source

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

Get a value from an LLVMValueRef.

§Safety

The ref must be valid and of type struct.

source

pub fn get_field_at_index(self, index: u32) -> Option<BasicValueEnum<'ctx>>

Gets the value of a field belonging to this StructValue.

use inkwell::context::Context;

let context = Context::create();
let i32_type = context.i32_type();
let i8_type = context.i8_type();
let i8_val = i8_type.const_all_ones();
let i32_val = i32_type.const_all_ones();
let struct_type = context.struct_type(&[i8_type.into(), i32_type.into()], false);
let struct_val = struct_type.const_named_struct(&[i8_val.into(), i32_val.into()]);

assert!(struct_val.get_field_at_index(0).is_some());
assert!(struct_val.get_field_at_index(1).is_some());
assert!(struct_val.get_field_at_index(3).is_none());
assert!(struct_val.get_field_at_index(0).unwrap().is_int_value());
source

pub unsafe fn get_field_at_index_unchecked( self, index: u32, ) -> BasicValueEnum<'ctx>

Gets the value of a field belonging to this StructValue.

§Safety

The index must be smaller than StructValue::count_fields.

source

pub fn get_fields(self) -> FieldValueIter<'ctx>

Get a field value iterator.

source

pub fn set_field_at_index<BV: BasicValue<'ctx>>( self, index: u32, val: BV, ) -> bool

Sets the value of a field belonging to this StructValue.

source

pub fn count_fields(self) -> u32

Counts the number of fields.

use inkwell::context::Context;

let context = Context::create();
let i32_type = context.i32_type();
let i8_type = context.i8_type();
let i8_val = i8_type.const_all_ones();
let i32_val = i32_type.const_all_ones();
let struct_type = context.struct_type(&[i8_type.into(), i32_type.into()], false);
let struct_val = struct_type.const_named_struct(&[i8_val.into(), i32_val.into()]);

assert_eq!(struct_val.count_fields(), 2);
assert_eq!(struct_val.count_fields(), struct_type.count_fields());
source

pub fn get_name(&self) -> &CStr

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

source

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

Get name of the StructValue.

source

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

source

pub fn is_null(self) -> bool

source

pub fn is_undef(self) -> bool

source

pub fn print_to_stderr(self)

source

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

source

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

source

pub fn is_const(self) -> bool

Determines whether or not a StructValue is a constant.

§Example
use inkwell::{context::Context, values::BasicValue};

let context = Context::create();
let i64_type = context.i64_type();
let i64_val = i64_type.const_int(23, false).as_basic_value_enum();
let struct_val = context.const_struct(&[i64_val, i64_val], false);

assert!(struct_val.is_const());

Trait Implementations§

source§

impl<'ctx> AggregateValue<'ctx> for StructValue<'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 StructValue<'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 StructValue<'_>

source§

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

source§

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

source§

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

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

impl Display for StructValue<'_>

source§

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

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

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

impl<'ctx> Eq for StructValue<'ctx>

source§

impl<'ctx> StructuralPartialEq for StructValue<'ctx>

Auto Trait Implementations§

§

impl<'ctx> Freeze for StructValue<'ctx>

§

impl<'ctx> RefUnwindSafe for StructValue<'ctx>

§

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

§

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

§

impl<'ctx> Unpin for StructValue<'ctx>

§

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