Struct llvm_plugin_inkwell::intrinsics::Intrinsic

pub struct Intrinsic { /* private fields */ }

Implementations

impl Intrinsic

A wrapper around LLVM intrinsic id

To call it you would need to create a declaration inside a module using Self::get_declaration().

pub fn find(name: &str) -> Option<Self>

Find llvm intrinsic id from name

Example

use inkwell::{intrinsics::Intrinsic, context::Context};

let trap_intrinsic = Intrinsic::find("llvm.trap").unwrap();

let context = Context::create();
let module = context.create_module("trap");
let builder = context.create_builder();
let void_type = context.void_type();
let fn_type = void_type.fn_type(&[], false);
let fn_value = module.add_function("trap", fn_type, None);
let entry = context.append_basic_block(fn_value, "entry");

let trap_function = trap_intrinsic.get_declaration(&module, &[]).unwrap();

builder.position_at_end(entry);
builder.build_call(trap_function, &[], "trap_call");

pub fn is_overloaded(&self) -> bool

Check if specified intrinsic is overloaded

Overloaded intrinsics need some argument types to be specified to declare them

pub fn get_declaration<'ctx>(
    &self,
    module: &Module<'ctx>,
    param_types: &[BasicTypeEnum<'_>]
) -> Option<FunctionValue<'ctx>>

Create or insert the declaration of an intrinsic.

For overloaded intrinsics, parameter types must be provided to uniquely identify an overload.

Example

use inkwell::{intrinsics::Intrinsic, context::Context};

let trap_intrinsic = Intrinsic::find("llvm.trap").unwrap();

let context = Context::create();
let module = context.create_module("trap");
let builder = context.create_builder();
let void_type = context.void_type();
let fn_type = void_type.fn_type(&[], false);
let fn_value = module.add_function("trap", fn_type, None);
let entry = context.append_basic_block(fn_value, "entry");

let trap_function = trap_intrinsic.get_declaration(&module, &[]).unwrap();

builder.position_at_end(entry);
builder.build_call(trap_function, &[], "trap_call");

Trait Implementations

impl Clone for Intrinsic

fn clone(&self) -> Intrinsic

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Intrinsic

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

Formats the value using the given formatter.

impl PartialEq<Intrinsic> for Intrinsic

fn eq(&self, other: &Intrinsic) -> 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 Copy for Intrinsic

impl Eq for Intrinsic

impl StructuralEq for Intrinsic

impl StructuralPartialEq for Intrinsic