Struct inkwell::values::FloatValue

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

Implementations

impl<'ctx> FloatValue<'ctx>

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

Get a value from an LLVMValueRef.

Safety

The ref must be valid and of type float.

pub fn get_name(&self) -> &CStr

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

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

Set name of the FloatValue.

pub fn get_type(self) -> FloatType<'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 const_cast(self, float_type: FloatType<'ctx>) -> Self

Available on crate features llvm4-0 or llvm5-0 or llvm6-0 or llvm7-0 or llvm8-0 or llvm9-0 or llvm10-0 or llvm11-0 or llvm12-0 or llvm13-0 or llvm14-0 or llvm15-0 or llvm16-0 or llvm17-0 only.

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

Available on crate features llvm4-0 or llvm5-0 or llvm6-0 or llvm7-0 or llvm8-0 or llvm9-0 or llvm10-0 or llvm11-0 or llvm12-0 or llvm13-0 or llvm14-0 or llvm15-0 or llvm16-0 or llvm17-0 only.

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

Available on crate features llvm4-0 or llvm5-0 or llvm6-0 or llvm7-0 or llvm8-0 or llvm9-0 or llvm10-0 or llvm11-0 or llvm12-0 or llvm13-0 or llvm14-0 or llvm15-0 or llvm16-0 or llvm17-0 only.

pub fn const_truncate(self, float_type: FloatType<'ctx>) -> FloatValue<'ctx>

Available on crate features llvm4-0 or llvm5-0 or llvm6-0 or llvm7-0 or llvm8-0 or llvm9-0 or llvm10-0 or llvm11-0 or llvm12-0 or llvm13-0 or llvm14-0 or llvm15-0 or llvm16-0 or llvm17-0 only.

pub fn const_extend(self, float_type: FloatType<'ctx>) -> FloatValue<'ctx>

Available on crate features llvm4-0 or llvm5-0 or llvm6-0 or llvm7-0 or llvm8-0 or llvm9-0 or llvm10-0 or llvm11-0 or llvm12-0 or llvm13-0 or llvm14-0 or llvm15-0 or llvm16-0 or llvm17-0 only.

pub fn const_compare( self, op: FloatPredicate, rhs: FloatValue<'ctx> ) -> IntValue<'ctx>

pub fn is_const(self) -> bool

Determines whether or not a FloatValue is a constant.

Example

use inkwell::context::Context;

let context = Context::create();
let f64_type = context.f64_type();
let f64_val = f64_type.const_float(1.2);

assert!(f64_val.is_const());

pub fn get_constant(self) -> Option<(f64, bool)>

Obtains a constant FloatValue’s value and whether or not it lost info.

Example

use inkwell::context::Context;

let context = Context::create();
let f64_type = context.f64_type();
let f64_1_2 = f64_type.const_float(1.2);

assert_eq!(f64_1_2.get_constant(), Some((1.2, false)));

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

Trait Implementations

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

fn as_value_ref(&self) -> LLVMValueRef

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'ctx> Debug for FloatValue<'ctx>

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

Formats the value using the given formatter.

impl Display for FloatValue<'_>

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

Formats the value using the given formatter.

impl<'ctx> FloatMathValue<'ctx> for FloatValue<'ctx>

type BaseType = FloatType<'ctx>

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

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

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

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

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

impl<'ctx> Eq for FloatValue<'ctx>

impl<'ctx> StructuralPartialEq for FloatValue<'ctx>