Expand description
Inkwell documentation is a work in progress.
If you have any LLVM knowledge that could be used to improve these docs, we would greatly appreciate you opening an issue and/or a pull request on our GitHub page.
Due to a rustdoc issue, this documentation represents only the latest supported LLVM version. We hope that this issue will be resolved in the future so that multiple versions can be documented side by side.
§Library Wide Notes
- Most functions which take a string slice as input may possibly panic in the unlikely event that a c style string cannot be created based on it. (IE if your slice already has a null byte in it)
Re-exports§
pub extern crate llvm_sys_180 as llvm_
sys;
Modules§
- attributes
Attribute
s are optional modifiers to functions, function parameters, and return types.- basic_
block - A
BasicBlock
is a container of instructions. - builder
- A
Builder
enables you to build instructions. - comdat
- A
Comdat
helps resolve linker errors for duplicate sections. - context
- A
Context
is an opaque owner and manager of core global data. - data_
layout - debug_
info - Debug symbols -
DebugInfoBuilder
interface - execution_
engine - intrinsics
- memory_
buffer - memory_
manager - module
- A
Module
represents a single code compilation unit. - object_
file - passes
- support
- targets
- types
- A type is a classification which determines how data is used.
- values
- A value is an instance of a type.
Structs§
- Address
Space - Defines the address space in which a global will be inserted.
Enums§
- Atomic
Ordering - AtomicRMW
BinOp - DLLStorage
Class - Float
Predicate - Defines how to compare a
left
andright
FloatValue
. - Global
Visibility - Inline
AsmDialect llvm7-0
orllvm8-0
orllvm9-0
orllvm10-0
orllvm11-0
orllvm12-0
orllvm13-0
orllvm14-0
orllvm15-0
orllvm16-0
orllvm17-0
orllvm18-0
- IntPredicate
- This enum defines how to compare a
left
andright
IntValue
. - Optimization
Level - Defines the optimization level used to compile a
Module
. - Thread
Local Mode