edg-l/edlang
1
1
Fork 0
mirror of https://github.com/edg-l/edlang.git synced 2024-11-23 00:18:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
edlang/inkwell/index.html
edg-l 4cc2814406 deploy: 03a244db41
2024-05-05 09:43:20 +00:00

10 lines
10 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Inkwell documentation is a work in progress."><title>inkwell - Rust</title><script> if (window.location.protocol !== "file:") document.write(`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2">`)</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-e935ef01ae1c1829.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="inkwell" data-themes="" data-resource-suffix="" data-rustdoc-version="1.78.0 (9b00956e5 2024-04-29)" data-channel="1.78.0" data-search-js="search-42d8da7a6b9792c2.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-4c98445ec4002617.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-12cf3b4f4f9dc36d.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-04d5337699b92874.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../inkwell/index.html">inkwell</a><span class="version">0.4.0</span></h2></div><div class="sidebar-elems"><ul class="block">
<li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></section></div></nav><div class="sidebar-resizer"></div>
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../inkwell/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">inkwell</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/inkwell/lib.rs.html#1-496">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Inkwell documentation is a work in progress.</p>
<p>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 <a href="https://github.com/TheDan64/inkwell">GitHub page</a>.</p>
<p>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.</p>
<h2 id="library-wide-notes"><a class="doc-anchor" href="#library-wide-notes">§</a>Library Wide Notes</h2>
<ul>
<li>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)</li>
</ul>
</div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><code>pub extern crate <a class="mod" href="../llvm_sys/index.html" title="mod llvm_sys">llvm_sys_180</a> as llvm_sys;</code></div></li></ul><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="attributes/index.html" title="mod inkwell::attributes">attributes</a></div><div class="desc docblock-short"><code>Attribute</code>s are optional modifiers to functions, function parameters, and return types.</div></li><li><div class="item-name"><a class="mod" href="basic_block/index.html" title="mod inkwell::basic_block">basic_block</a></div><div class="desc docblock-short">A <code>BasicBlock</code> is a container of instructions.</div></li><li><div class="item-name"><a class="mod" href="builder/index.html" title="mod inkwell::builder">builder</a></div><div class="desc docblock-short">A <code>Builder</code> enables you to build instructions.</div></li><li><div class="item-name"><a class="mod" href="comdat/index.html" title="mod inkwell::comdat">comdat</a></div><div class="desc docblock-short">A <code>Comdat</code> helps resolve linker errors for duplicate sections.</div></li><li><div class="item-name"><a class="mod" href="context/index.html" title="mod inkwell::context">context</a></div><div class="desc docblock-short">A <code>Context</code> is an opaque owner and manager of core global data.</div></li><li><div class="item-name"><a class="mod" href="data_layout/index.html" title="mod inkwell::data_layout">data_layout</a></div></li><li><div class="item-name"><a class="mod" href="debug_info/index.html" title="mod inkwell::debug_info">debug_info</a></div><div class="desc docblock-short">Debug symbols - <code>DebugInfoBuilder</code> interface</div></li><li><div class="item-name"><a class="mod" href="execution_engine/index.html" title="mod inkwell::execution_engine">execution_engine</a></div></li><li><div class="item-name"><a class="mod" href="intrinsics/index.html" title="mod inkwell::intrinsics">intrinsics</a></div></li><li><div class="item-name"><a class="mod" href="memory_buffer/index.html" title="mod inkwell::memory_buffer">memory_buffer</a></div></li><li><div class="item-name"><a class="mod" href="module/index.html" title="mod inkwell::module">module</a></div><div class="desc docblock-short">A <code>Module</code> represents a single code compilation unit.</div></li><li><div class="item-name"><a class="mod" href="object_file/index.html" title="mod inkwell::object_file">object_file</a></div></li><li><div class="item-name"><a class="mod" href="passes/index.html" title="mod inkwell::passes">passes</a></div></li><li><div class="item-name"><a class="mod" href="support/index.html" title="mod inkwell::support">support</a></div></li><li><div class="item-name"><a class="mod" href="targets/index.html" title="mod inkwell::targets">targets</a></div></li><li><div class="item-name"><a class="mod" href="types/index.html" title="mod inkwell::types">types</a></div><div class="desc docblock-short">A type is a classification which determines how data is used.</div></li><li><div class="item-name"><a class="mod" href="values/index.html" title="mod inkwell::values">values</a></div><div class="desc docblock-short">A value is an instance of a type.</div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.AddressSpace.html" title="struct inkwell::AddressSpace">AddressSpace</a></div><div class="desc docblock-short">Defines the address space in which a global will be inserted.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.AtomicOrdering.html" title="enum inkwell::AtomicOrdering">AtomicOrdering</a></div></li><li><div class="item-name"><a class="enum" href="enum.AtomicRMWBinOp.html" title="enum inkwell::AtomicRMWBinOp">AtomicRMWBinOp</a></div></li><li><div class="item-name"><a class="enum" href="enum.DLLStorageClass.html" title="enum inkwell::DLLStorageClass">DLLStorageClass</a></div></li><li><div class="item-name"><a class="enum" href="enum.FloatPredicate.html" title="enum inkwell::FloatPredicate">FloatPredicate</a></div><div class="desc docblock-short">Defines how to compare a <code>left</code> and <code>right</code> <code>FloatValue</code>.</div></li><li><div class="item-name"><a class="enum" href="enum.GlobalVisibility.html" title="enum inkwell::GlobalVisibility">GlobalVisibility</a></div></li><li><div class="item-name"><a class="enum" href="enum.InlineAsmDialect.html" title="enum inkwell::InlineAsmDialect">InlineAsmDialect</a></div></li><li><div class="item-name"><a class="enum" href="enum.IntPredicate.html" title="enum inkwell::IntPredicate">IntPredicate</a></div><div class="desc docblock-short">This enum defines how to compare a <code>left</code> and <code>right</code> <code>IntValue</code>.</div></li><li><div class="item-name"><a class="enum" href="enum.OptimizationLevel.html" title="enum inkwell::OptimizationLevel">OptimizationLevel</a></div><div class="desc docblock-short">Defines the optimization level used to compile a <code>Module</code>.</div></li><li><div class="item-name"><a class="enum" href="enum.ThreadLocalMode.html" title="enum inkwell::ThreadLocalMode">ThreadLocalMode</a></div></li></ul></section></div></main></body></html>
Reference in a new issue View git blame Copy permalink