17 lines
5.7 KiB
HTML
17 lines
5.7 KiB
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="`deflate_file!("file")` is equivalent to `include_bytes!("file.gz")`."><meta name="keywords" content="rust, rustlang, rust-lang, proc_macro_hack_deflate_file"><title>proc_macro_hack_deflate_file in include_flate_codegen - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.js"></script><script defer src="../main.js"></script>
|
||
<noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc macro"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../include_flate_codegen/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.png" alt="logo"></div>
|
||
</a><div class="sidebar-elems"><h2 class="location">Other items in<br><a href="index.html">include_flate_codegen</a></h2><div id="sidebar-vars" data-name="proc_macro_hack_deflate_file" data-ty="macro" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../include_flate_codegen/index.html"><img class="rust-logo" src="../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">Macro <a href="index.html">include_flate_codegen</a>::<wbr><a class="macro" href="#">proc_macro_hack_deflate_file</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/include_flate_codegen/lib.rs.html#45" title="goto source code">[src]</a></span></h1><div class="docblock item-decl"><pre class="rust macro"><code>proc_macro_hack_deflate_file!() { /* proc-macro */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>deflate_file!("file")</code> is equivalent to <code>include_bytes!("file.gz")</code>.</p>
|
||
<h2 id="parameters" class="section-header"><a href="#parameters">Parameters</a></h2>
|
||
<p>This macro accepts exactly one literal parameter that refers to a path, either absolute or relative to <code>CARGO_MANIFEST_DIR</code>.</p>
|
||
<p>Note that <strong>this is distinct from the behaviour of the builtin <code>include_bytes!</code>/<code>include_str!</code> macros</strong> —
|
||
<code>includle_bytes!</code>/<code>include_str!</code> paths are relative to the current source file, while <code>deflate_file!</code> paths are relative to
|
||
<code>CARGO_MANIFEST_DIR</code>.</p>
|
||
<h2 id="returns" class="section-header"><a href="#returns">Returns</a></h2>
|
||
<p>This macro expands to a <code>b"byte string"</code> literal that contains the deflated form of the file.</p>
|
||
<h2 id="compile-errors" class="section-header"><a href="#compile-errors">Compile errors</a></h2>
|
||
<ul>
|
||
<li>If the argument is not a single literal</li>
|
||
<li>If the referenced file does not exist or is not readable</li>
|
||
</ul>
|
||
</div></details></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="include_flate_codegen" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |