edg-l/edlang
1
1
Fork 0
mirror of https://github.com/edg-l/edlang.git synced 2024-10-19 07:18:23 +00:00
Code Issues Packages Projects Releases Wiki Activity
edlang/llvm_sys/remarks/index.html

8 lines
15 KiB
HTML
Raw Normal View History

deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
<!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="Remark diagnostics library."><title>llvm_sys::remarks - Rust</title><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"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="llvm_sys" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.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"><!--[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">&#9776;</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../llvm_sys/index.html">llvm_sys</a><span class="version">170.0.1</span></h2></div><h2 class="location"><a href="#">Module remarks</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Aliases</a></li></ul></section><h2><a href="../index.html">In crate llvm_sys</a></h2></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="../../llvm_sys/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>Module <a href="../index.html">llvm_sys</a>::<wbr><a class="mod" href="#">remarks</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/llvm_sys/remarks.rs.html#1-134">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>Remark diagnostics library.</p>
</div></details><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.LLVMRemarkOpaqueArg.html" title="enum llvm_sys::remarks::LLVMRemarkOpaqueArg">LLVMRemarkOpaqueArg</a></div></li><li><div class="item-name"><a class="enum" href="enum.LLVMRemarkOpaqueDebugLoc.html" title="enum llvm_sys::remarks::LLVMRemarkOpaqueDebugLoc">LLVMRemarkOpaqueDebugLoc</a></div></li><li><div class="item-name"><a class="enum" href="enum.LLVMRemarkOpaqueEntry.html" title="enum llvm_sys::remarks::LLVMRemarkOpaqueEntry">LLVMRemarkOpaqueEntry</a></div></li><li><div class="item-name"><a class="enum" href="enum.LLVMRemarkOpaqueParser.html" title="enum llvm_sys::remarks::LLVMRemarkOpaqueParser">LLVMRemarkOpaqueParser</a></div></li><li><div class="item-name"><a class="enum" href="enum.LLVMRemarkOpaqueString.html" title="enum llvm_sys::remarks::LLVMRemarkOpaqueString">LLVMRemarkOpaqueString</a></div></li><li><div class="item-name"><a class="enum" href="enum.LLVMRemarkType.html" title="enum llvm_sys::remarks::LLVMRemarkType">LLVMRemarkType</a></div></li></ul><h2 id="constants" class="section-header"><a href="#constants">Constants</a></h2><ul class="item-table"><li><div class="item-name"><a class="constant" href="constant.REMARKS_API_VERSION.html" title="constant llvm_sys::remarks::REMARKS_API_VERSION">REMARKS_API_VERSION</a></div></li></ul><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.LLVMRemarkArgGetDebugLoc.html" title="fn llvm_sys::remarks::LLVMRemarkArgGetDebugLoc">LLVMRemarkArgGetDebugLoc</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Returns the debug location that is attached to the value of this argument.</div></li><li><div class="item-name"><a class="fn" href="fn.LLVMRemarkArgGetKey.html" title="fn llvm_sys::remarks::LLVMRemarkArgGetKey">LLVMRemarkArgGetKey</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Returns the key of an argument. The key defines what the value is, and the
same key can appear multiple times in the list of arguments.</div></li><li><div class="item-name"><a class="fn" href="fn.LLVMRemarkArgGetValue.html" title="fn llvm_sys::remarks::LLVMRemarkArgGetValue">LLVMRemarkArgGetValue</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Returns the value of an argument. This is a string that can contain newlines.</div></li><li><div class="item-name"><a class="fn" href="fn.LLVMRemarkDebugLocGetSourceColumn.html" title="fn llvm_sys::remarks::LLVMRemarkDebugLocGetSourceColumn">LLVMRemarkDebugLocGetSourceColumn</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Return the column in the source file for a debug location.</div></li><li><div class="item-name"><a class="fn" href="fn.LLVMRemarkDebugLocGetSourceFilePath.html" title="fn llvm_sys::remarks::LLVMRemarkDebugLocGetSourceFilePath">LLVMRemarkDebugLocGetSourceFilePath</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Return the path to the source file for a debug location.</div></li><li><div class="item-name"><a class="fn" href="fn.LLVMRemarkDebugLocGetSourceLine.html" title="fn llvm_sys::remarks::LLVMRemarkDebugLocGetSourceLine">LLVMRemarkDebugLocGetSourceLine</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Return the line in the source file for a debug location.</div></li><li><div class="item-name"><a class="fn" href="fn.LLVMRemarkEntryDispose.html" title="fn llvm_sys::remarks::LLVMRemarkEntryDispose">LLVMRemarkEntryDispose</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Free the resources used by the remark entry.</div></li><li><div class="item-name"><a class="fn" href="fn.LLVMRemarkEntryGetDebugLoc.html" title="fn llvm_sys::remarks::LLVMRemarkEntryGetDebugLoc">LLVMRemarkEntryGetDebugLoc</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Returns the debug location that is attached to this remark.</div></li><li><div class="item-name"><a class="fn" href="fn.LLVMRemarkEntryGetFirstArg.html" title="fn llvm_sys::remarks::LLVMRemarkEntryGetFirstArg">LLVMRemarkEntryGetFirstArg</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Get a new iterator to iterate over a remark’s argument.</div></li><li><div class="item-name"><a class="fn" href="fn.LLVMRemarkEntryGetFunctionName.html" title="fn llvm_sys::remarks::LLVMRemarkEntryGetFunctionName">LLVMRemarkEntryGetFunctionName</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Get the name of the function being processed when the remark was emitted.</div></li><li><div class="item-name"><a class="fn" href="fn.LLVMRemarkEntryGetHotness.html" title="fn llvm_sys::remarks::LLVMRemarkEntryGetHotness">LLVMRemarkEntryGetHotness</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Return the hotness of the remark.</div></li><li><div class="item-name"><a class="fn" href="fn.LLVMRemarkEntryGetNextArg.html" title="fn llvm_sys::remarks::LLVMRemarkEntryGetNextArg">LLVMRemarkEntryGetNextArg</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Get the next argument in Remark from the position of It.</div></li><li><div class="item-name"><a class="fn" href="fn.LLVMRemarkEntryGetNumArgs.html" title="fn llvm_sys::remarks::LLVMRemarkEntryGetNumArgs">LLVMRemarkEntryGetNumArgs</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">The number of arguments the remark holds.</div></li><li><div class="item-name"><a class="fn" href="fn.LLVMRemarkEntryGetPassName.html" title="fn llvm_sys::remarks::LLVMRemarkEntryGetPassName">LLVMRemarkEntryGetPassName</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Get the name of the pass that emitted this remark.</div></li><li><div class="item-name"><a class="fn" href="fn.LLVMRemarkEntryGetRemarkName.html" title="fn llvm_sys::remarks::LLVMRemarkEntryGetRemarkName">LLVMRemarkEntryGetRemarkName</a><sup title="unsafe function">⚠</sup></div><div clas
missed optimizations from the compiler.</div></li><li><div class="item-name"><a class="fn" href="fn.LLVMRemarkParserCreateBitstream.html" title="fn llvm_sys::remarks::LLVMRemarkParserCreateBitstream">LLVMRemarkParserCreateBitstream</a><sup title="unsafe function">⚠</sup></div></li><li><div class="item-name"><a class="fn" href="fn.LLVMRemarkParserCreateYAML.html" title="fn llvm_sys::remarks::LLVMRemarkParserCreateYAML">LLVMRemarkParserCreateYAML</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Creates a remark parser that can be used to parse the buffer located in
Buf of size Size bytes.</div></li><li><div class="item-name"><a class="fn" href="fn.LLVMRemarkParserDispose.html" title="fn llvm_sys::remarks::LLVMRemarkParserDispose">LLVMRemarkParserDispose</a><sup title="unsafe function">⚠</sup></div></li><li><div class="item-name"><a class="fn" href="fn.LLVMRemarkParserGetErrorMessage.html" title="fn llvm_sys::remarks::LLVMRemarkParserGetErrorMessage">LLVMRemarkParserGetErrorMessage</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Returns a null-terminated string containing an error message.</div></li><li><div class="item-name"><a class="fn" href="fn.LLVMRemarkParserGetNext.html" title="fn llvm_sys::remarks::LLVMRemarkParserGetNext">LLVMRemarkParserGetNext</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Returns the next remark in the file.</div></li><li><div class="item-name"><a class="fn" href="fn.LLVMRemarkParserHasError.html" title="fn llvm_sys::remarks::LLVMRemarkParserHasError">LLVMRemarkParserHasError</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Returns <code>1</code> if the parser encountered an error while parsing the buffer.</div></li><li><div class="item-name"><a class="fn" href="fn.LLVMRemarkStringGetData.html" title="fn llvm_sys::remarks::LLVMRemarkStringGetData">LLVMRemarkStringGetData</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Returns the buffer holding the string.</div></li><li><div class="item-name"><a class="fn" href="fn.LLVMRemarkStringGetLen.html" title="fn llvm_sys::remarks::LLVMRemarkStringGetLen">LLVMRemarkStringGetLen</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Returns the size of the string.</div></li><li><div class="item-name"><a class="fn" href="fn.LLVMRemarkVersion.html" title="fn llvm_sys::remarks::LLVMRemarkVersion">LLVMRemarkVersion</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Returns the version of the remarks library.</div></li></ul><h2 id="types" class="section-header"><a href="#types">Type Aliases</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.LLVMRemarkArgRef.html" title="type llvm_sys::remarks::LLVMRemarkArgRef">LLVMRemarkArgRef</a></div><div class="desc docblock-short">Element of the “Args” list. The key might give more information about what
the semantics of the value are, e.g. “Callee” will tell you that the value
is a symbol that names a function.</div></li><li><div class="item-name"><a class="type" href="type.LLVMRemarkDebugLocRef.html" title="type llvm_sys::remarks::LLVMRemarkDebugLocRef">LLVMRemarkDebugLocRef</a></div><div class="desc docblock-short">DebugLoc containing File, Line and Column.</div></li><li><div class="item-name"><a class="type" href="type.LLVMRemarkEntryRef.html" title="type llvm_sys::remarks::LLVMRemarkEntryRef">LLVMRemarkEntryRef</a></div><div class="desc docblock-short">A remark emitted by the compiler.</div></li><li><div class="item-name"><a class="type" href="type.LLVMRemarkParserRef.html" title="type llvm_sys::remarks::LLVMRemarkParserRef">LLVMRemarkParserRef</a></div></li><li><div class="item-name"><a class="type" href="type.LLVMRemarkStringRef.html" title="type llvm_sys::remarks::LLVMRemarkStringRef">LLVMRemarkStringRef</a></div><div class="desc docblock-short">String containing a buffer and a length. The buffer is not guaranteed to be zero-terminated.</div></li></ul></section></div></main></body></html>
Reference in a new issue Copy permalink