Struct StructValue

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

Implementations

impl<'ctx> StructValue<'ctx>

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

Get a value from an LLVMValueRef.

Safety

The ref must be valid and of type struct.

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

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.

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

Get a field value iterator.

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.

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

pub fn get_name(&self) -> &CStr

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

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

Get name of the StructValue.

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

pub fn is_null(self) -> bool

pub fn is_undef(self) -> bool

pub fn print_to_stderr(self)

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

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

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

impl<'ctx> AggregateValue<'ctx> for StructValue<'ctx>

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

Returns an enum containing a typed version of the AggregateValue.

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

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

impl AsValueRef for StructValue<'_>

fn as_value_ref(&self) -> LLVMValueRef

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'ctx> Debug for StructValue<'ctx>

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

Formats the value using the given formatter.

impl Display for StructValue<'_>

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Tests for self and other values to be equal, and is used by ==.

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

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

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

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

Tests for self and other values to be equal, and is used by ==.

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

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

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

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

Tests for self and other values to be equal, and is used by ==.

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

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

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

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

Tests for self and other values to be equal, and is used by ==.

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

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

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

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

Tests for self and other values to be equal, and is used by ==.

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

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

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

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

Tests for self and other values to be equal, and is used by ==.

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

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

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

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

Tests for self and other values to be equal, and is used by ==.

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

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

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

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'ctx> PartialEq for StructValue<'ctx>

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

Tests for self and other values to be equal, and is used by ==.

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

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

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

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

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