edlang/inkwell/support/index.html

<!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="API documentation for the Rust `support` mod in crate `inkwell`."><title>inkwell::support - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-dd39b87e5fcfba68.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.80.0 (051478957 2024-07-21)" data-channel="1.80.0" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-df360f571f6edeae.css"></noscript><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"><!--[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><h2 class="location"><a href="#">Module support</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li></ul></section><h2><a href="../index.html">In crate inkwell</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">inkwell</a>::<wbr><a class="mod" href="#">support</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/inkwell/support/mod.rs.html#1-234">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><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="error_handling/index.html" title="mod inkwell::support::error_handling">error_handling</a></div><div class="desc docblock-short">This module contains some supplemental functions for dealing with errors.</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.LLVMString.html" title="struct inkwell::support::LLVMString">LLVMString</a></div><div class="desc docblock-short">An owned LLVM String. Also known as a LLVM Message</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.LoadLibraryError.html" title="enum inkwell::support::LoadLibraryError">LoadLibraryError</a></div><div class="desc docblock-short">Possible errors that can occur when loading a library</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.enable_llvm_pretty_stack_trace.html" title="fn inkwell::support::enable_llvm_pretty_stack_trace">enable_llvm_pretty_stack_trace</a></div></li><li><div class="item-name"><a class="fn" href="fn.get_llvm_version.html" title="fn inkwell::support::get_llvm_version">get_llvm_version</a></div><div class="desc docblock-short">Returns the major, minor, and patch version of the LLVM in use</div></li><li><div class="item-name"><a class="fn" href="fn.is_multithreaded.html" title="fn inkwell::support::is_multithreaded">is_multithreaded</a></div><div class="desc docblock-short">Determines whether or not LLVM has been configured to run in multithreaded mode. (Inkwell currently does
not officially support multithreaded mode)</div></li><li><div class="item-name"><a class="fn" href="fn.load_library_permanently.html" title="fn inkwell::support::load_library_permanently">load_library_permanently</a></div><div class="desc docblock-short">Permanently load the dynamic library at the given <code>path</code>.</div></li><li><div class="item-name"><a class="fn" href="fn.load_visible_symbols.html" title="fn inkwell::support::load_visible_symbols">load_visible_symbols</a></div><div class="desc docblock-short">Permanently loads all the symbols visible inside the current program</div></li><li><div class="item-name"><a class="fn" href="fn.search_for_address_of_symbol.html" title="fn inkwell::support::search_for_address_of_symbol">search_for_address_of_symbol</a></div><div class="desc docblock-short">Search through all previously loaded dynamic libraries for <code>symbol</code>.</div></li><li><div class="item-name"><a class="fn" href="fn.shutdown_llvm.html" title="fn inkwell::support::shutdown_llvm">shutdown_llvm</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">This function is very unsafe. Any reference to LLVM data after this function is called will likely segfault.
Probably only ever useful to call before your program ends. Might not even be absolutely necessary.</div></li></ul></section></div></main></body></html>
	<!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="API documentation for the Rust `support` mod in crate `inkwell`."><title>inkwell::support - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-dd39b87e5fcfba68.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.80.0 (051478957 2024-07-21)" data-channel="1.80.0" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-df360f571f6edeae.css"></noscript><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"><!--[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><h2 class="location"><a href="#">Module support</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li></ul></section><h2><a href="../index.html">In crate inkwell</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">inkwell</a>::<wbr><a class="mod" href="#">support</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/inkwell/support/mod.rs.html#1-234">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><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="error_handling/index.html" title="mod inkwell::support::error_handling">error_handling</a></div><div class="desc docblock-short">This module contains some supplemental functions for dealing with errors.</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.LLVMString.html" title="struct inkwell::support::LLVMString">LLVMString</a></div><div class="desc docblock-short">An owned LLVM String. Also known as a LLVM Message</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.LoadLibraryError.html" title="enum inkwell::support::LoadLibraryError">LoadLibraryError</a></div><div class="desc docblock-short">Possible errors that can occur when loading a library</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.enable_llvm_pretty_stack_trace.html" title="fn inkwell::support::enable_llvm_pretty_stack_trace">enable_llvm_pretty_stack_trace</a></div></li><li><div class="item-name"><a class="fn" href="fn.get_llvm_version.html" title="fn inkwell::support::get_llvm_version">get_llvm_version</a></div><div class="desc docblock-short">Returns the major, minor, and patch version of the LLVM in use</div></li><li><div class="item-name"><a class="fn" href="fn.is_multithreaded.html" title="fn inkwell::support::is_multithreaded">is_multithreaded</a></div><div class="desc docblock-short">Determines whether or not LLVM has been configured to run in multithreaded mode. (Inkwell currently does
	not officially support multithreaded mode)</div></li><li><div class="item-name"><a class="fn" href="fn.load_library_permanently.html" title="fn inkwell::support::load_library_permanently">load_library_permanently</a></div><div class="desc docblock-short">Permanently load the dynamic library at the given <code>path</code>.</div></li><li><div class="item-name"><a class="fn" href="fn.load_visible_symbols.html" title="fn inkwell::support::load_visible_symbols">load_visible_symbols</a></div><div class="desc docblock-short">Permanently loads all the symbols visible inside the current program</div></li><li><div class="item-name"><a class="fn" href="fn.search_for_address_of_symbol.html" title="fn inkwell::support::search_for_address_of_symbol">search_for_address_of_symbol</a></div><div class="desc docblock-short">Search through all previously loaded dynamic libraries for <code>symbol</code>.</div></li><li><div class="item-name"><a class="fn" href="fn.shutdown_llvm.html" title="fn inkwell::support::shutdown_llvm">shutdown_llvm</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">This function is very unsafe. Any reference to LLVM data after this function is called will likely segfault.
	`Probably only ever useful to call before your program ends. Might not even be absolutely necessary.</div></li></ul></section></div></main></body></html>`