Enum inkwell::types::BasicTypeEnum

pub enum BasicTypeEnum<'ctx> {
    ArrayType(ArrayType<'ctx>),
    FloatType(FloatType<'ctx>),
    IntType(IntType<'ctx>),
    PointerType(PointerType<'ctx>),
    StructType(StructType<'ctx>),
    VectorType(VectorType<'ctx>),
}

A wrapper for any BasicType.

Variants

ArrayType(ArrayType<'ctx>)

A contiguous homogeneous container type.

FloatType(FloatType<'ctx>)

A floating point type.

IntType(IntType<'ctx>)

An integer type.

PointerType(PointerType<'ctx>)

A pointer type.

StructType(StructType<'ctx>)

A contiguous heterogeneous container type.

VectorType(VectorType<'ctx>)

A contiguous homogeneous “SIMD” container type.

Implementations

impl<'ctx> BasicTypeEnum<'ctx>

pub unsafe fn new(type_: LLVMTypeRef) -> Self

Create BasicTypeEnum from LLVMTypeRef

Safety

Undefined behavior, if referenced type isn’t part of basic type enum.

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

pub fn into_float_type(self) -> FloatType<'ctx>

pub fn into_int_type(self) -> IntType<'ctx>

pub fn into_pointer_type(self) -> PointerType<'ctx>

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

pub fn into_vector_type(self) -> VectorType<'ctx>

pub fn is_array_type(self) -> bool

pub fn is_float_type(self) -> bool

pub fn is_int_type(self) -> bool

pub fn is_pointer_type(self) -> bool

pub fn is_struct_type(self) -> bool

pub fn is_vector_type(self) -> bool

pub fn const_zero(self) -> BasicValueEnum<'ctx>

Creates a constant BasicValueZero.

Example

use inkwell::context::Context;
use crate::inkwell::types::BasicType;

let context = Context::create();
let f32_type = context.f32_type().as_basic_type_enum();
let f32_zero = f32_type.const_zero();

pub fn print_to_string(self) -> LLVMString

Print the definition of a BasicTypeEnum to LLVMString.

Trait Implementations

impl<'ctx> AnyType<'ctx> for BasicTypeEnum<'ctx>

fn as_any_type_enum(&self) -> AnyTypeEnum<'ctx>

Returns an AnyTypeEnum that represents the current type.

fn print_to_string(&self) -> LLVMString

Prints the definition of a Type to a LLVMString.

impl AsTypeRef for BasicTypeEnum<'_>

fn as_type_ref(&self) -> LLVMTypeRef

Returns the internal LLVM reference behind the type

impl<'ctx> BasicType<'ctx> for BasicTypeEnum<'ctx>

fn as_basic_type_enum(&self) -> BasicTypeEnum<'ctx>

Returns a BasicTypeEnum that represents the current type.

fn fn_type( &self, param_types: &[BasicMetadataTypeEnum<'ctx>], is_var_args: bool, ) -> FunctionType<'ctx>

Create a FunctionType with this BasicType as its return type.

fn is_sized(&self) -> bool

Determines whether or not this BasicType is sized or not. For example, opaque structs are unsized.

fn size_of(&self) -> Option<IntValue<'ctx>>

Gets the size of this BasicType. Value may vary depending on the target architecture.

fn array_type(&self, size: u32) -> ArrayType<'ctx>

Create an ArrayType with this BasicType as its elements.

fn ptr_type(&self, address_space: AddressSpace) -> PointerType<'ctx>

👎Deprecated: Starting from version 15.0, LLVM doesn’t differentiate between pointer types. Use Context::ptr_type instead.

Create a PointerType that points to this BasicType.

impl<'ctx> Clone for BasicTypeEnum<'ctx>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'ctx> Debug for BasicTypeEnum<'ctx>

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

Formats the value using the given formatter.

impl Display for BasicTypeEnum<'_>

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

Formats the value using the given formatter.

impl<'ctx> From<ArrayType<'ctx>> for BasicTypeEnum<'ctx>

fn from(value: ArrayType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.

impl<'ctx> From<BasicTypeEnum<'ctx>> for BasicMetadataTypeEnum<'ctx>

fn from(value: BasicTypeEnum<'ctx>) -> Self

Converts to this type from the input type.

impl<'ctx> From<FloatType<'ctx>> for BasicTypeEnum<'ctx>

fn from(value: FloatType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.

impl<'ctx> From<IntType<'ctx>> for BasicTypeEnum<'ctx>

fn from(value: IntType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.

impl<'ctx> From<PointerType<'ctx>> for BasicTypeEnum<'ctx>

fn from(value: PointerType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.

impl<'ctx> From<StructType<'ctx>> for BasicTypeEnum<'ctx>

fn from(value: StructType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.

impl<'ctx> From<VectorType<'ctx>> for BasicTypeEnum<'ctx>

fn from(value: VectorType<'_>) -> BasicTypeEnum<'_>

Converts to this type from the input type.

impl<'ctx> PartialEq for BasicTypeEnum<'ctx>

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

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'ctx> TryFrom<BasicMetadataTypeEnum<'ctx>> for BasicTypeEnum<'ctx>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for ArrayType<'ctx>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for FloatType<'ctx>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for IntType<'ctx>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for PointerType<'ctx>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for StructType<'ctx>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'ctx> TryFrom<BasicTypeEnum<'ctx>> for VectorType<'ctx>

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'ctx> Copy for BasicTypeEnum<'ctx>

impl<'ctx> Eq for BasicTypeEnum<'ctx>

impl<'ctx> StructuralPartialEq for BasicTypeEnum<'ctx>