Struct inkwell::types::VoidType

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

A VoidType is a special type with no possible direct instances. It’s only useful as a function return type.

Implementations

impl<'ctx> VoidType<'ctx>

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

Create VoidType from LLVMTypeRef

Safety

Undefined behavior, if referenced type isn’t void type

pub fn is_sized(self) -> bool

Gets whether or not this VoidType is sized or not. This may always be false and as such this function may be removed in the future.

Example

use inkwell::context::Context;

let context = Context::create();
let void_type = context.void_type();

assert!(void_type.is_sized());

pub fn get_context(self) -> ContextRef<'ctx>

Gets a reference to the Context this VoidType was created in.

Example

use inkwell::context::Context;

let context = Context::create();
let void_type = context.void_type();

assert_eq!(void_type.get_context(), context);

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

Creates a FunctionType with this VoidType for its return type. This means the function does not return.

Example

use inkwell::context::Context;

let context = Context::create();
let void_type = context.void_type();
let fn_type = void_type.fn_type(&[], false);

pub fn print_to_string(self) -> LLVMString

Print the definition of a VoidType to LLVMString.

Trait Implementations

impl<'ctx> AnyType<'ctx> for VoidType<'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 VoidType<'_>

fn as_type_ref(&self) -> LLVMTypeRef

Returns the internal LLVM reference behind the type

impl<'ctx> Clone for VoidType<'ctx>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'ctx> Debug for VoidType<'ctx>

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

Formats the value using the given formatter.

impl Display for VoidType<'_>

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

Formats the value using the given formatter.

impl<'ctx> From<VoidType<'ctx>> for AnyTypeEnum<'ctx>

fn from(value: VoidType<'_>) -> AnyTypeEnum<'_>

Converts to this type from the input type.

impl<'ctx> PartialEq for VoidType<'ctx>

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

impl<'ctx> Eq for VoidType<'ctx>

impl<'ctx> StructuralPartialEq for VoidType<'ctx>