39 lines
No EOL
6.3 KiB
HTML
39 lines
No EOL
6.3 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="API documentation for the Rust `processor` mod in crate `cache_buster`."><meta name="keywords" content="rust, rustlang, rust-lang, processor"><title>cache_buster::processor - Rust</title><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="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../cache_buster/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Module processor</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class="location"><a href="../index.html">cache_buster</a></p><div id="sidebar-vars" data-name="processor" data-ty="mod" data-relpath="../"></div><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><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" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">cache_buster</a>::<wbr><a class="mod" href="">processor</a></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/cache_buster/processor.rs.html#8-350" title="goto source code">[src]</a></span></h1><div class="docblock"><p>Module describing file processor that changes filenames to setup cache-busting</p>
|
||
<p>Run the following during build using <code>build.rs</code>:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">cache_buster</span>::<span class="ident">BusterBuilder</span>;
|
||
|
||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="comment">// note: add error checking yourself.</span>
|
||
<span class="comment">// println!("cargo:rustc-env=GIT_process={}", git_process);</span>
|
||
<span class="kw">let</span> <span class="ident">types</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[
|
||
<span class="ident">mime</span>::<span class="ident">IMAGE_PNG</span>,
|
||
<span class="ident">mime</span>::<span class="ident">IMAGE_SVG</span>,
|
||
<span class="ident">mime</span>::<span class="ident">IMAGE_JPEG</span>,
|
||
<span class="ident">mime</span>::<span class="ident">IMAGE_GIF</span>,
|
||
];
|
||
|
||
<span class="kw">let</span> <span class="ident">config</span> <span class="op">=</span> <span class="ident">BusterBuilder</span>::<span class="ident">default</span>()
|
||
.<span class="ident">source</span>(<span class="string">"./dist"</span>)
|
||
.<span class="ident">result</span>(<span class="string">"./prod"</span>)
|
||
.<span class="ident">mime_types</span>(<span class="ident">types</span>)
|
||
.<span class="ident">copy</span>(<span class="bool-val">true</span>)
|
||
.<span class="ident">follow_links</span>(<span class="bool-val">true</span>)
|
||
.<span class="ident">build</span>()
|
||
.<span class="ident">unwrap</span>();
|
||
|
||
<span class="ident">config</span>.<span class="ident">process</span>().<span class="ident">unwrap</span>();
|
||
}</pre></div>
|
||
<p>There's a runtime component to this library which will let you read modified
|
||
filenames from within your program. See [Files]</p>
|
||
</div><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
|
||
<table><tr class="module-item"><td><a class="struct" href="struct.Buster.html" title="cache_buster::processor::Buster struct">Buster</a></td><td class="docblock-short"><p>Configuration for setting up cache-busting</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BusterBuilder.html" title="cache_buster::processor::BusterBuilder struct">BusterBuilder</a></td><td class="docblock-short"><p>Builder for <a href="struct.Buster.html"><code>Buster</code></a>.</p>
|
||
</td></tr></table><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2>
|
||
<table><tr class="module-item"><td><a class="enum" href="enum.BusterBuilderError.html" title="cache_buster::processor::BusterBuilderError enum">BusterBuilderError</a></td><td class="docblock-short"><p>Error type for BusterBuilder</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="cache_buster"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |