Struct MetadataType

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

A MetadataType is the type of a metadata.

Implementations

impl<'ctx> MetadataType<'ctx>

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

Available on crate features 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 or llvm18-0 only.

Create MetadataType from LLVMTypeRef

Safety

Undefined behavior, if referenced type isn’t metadata type

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

Available on crate features 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 or llvm18-0 only.

Creates a FunctionType with this MetadataType for its return type.

Example

use inkwell::context::Context;

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

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

Available on crate features 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 or llvm18-0 only.

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

Example

use inkwell::context::Context;

let context = Context::create();
let md_type = context.metadata_type();

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

pub fn print_to_string(self) -> LLVMString

Print the definition of a MetadataType to LLVMString.

Trait Implementations

impl AsTypeRef for MetadataType<'_>

fn as_type_ref(&self) -> LLVMTypeRef

Returns the internal LLVM reference behind the type

impl<'ctx> Clone for MetadataType<'ctx>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'ctx> Debug for MetadataType<'ctx>

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

Formats the value using the given formatter.

impl Display for MetadataType<'_>

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

Formats the value using the given formatter.

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

fn from(value: MetadataType<'_>) -> BasicMetadataTypeEnum<'_>

Converts to this type from the input type.

impl<'ctx> PartialEq for MetadataType<'ctx>

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

impl<'ctx> Eq for MetadataType<'ctx>

impl<'ctx> StructuralPartialEq for MetadataType<'ctx>