realaravinth/libcachebust
1
0
Fork 0
Code Issues 1 Pull requests 4 Projects Releases Packages Wiki Activity
libcachebust/cache_buster/index.html

64 lines
8.4 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ d970b7031cd90649e30dc297eb5eba74832153e8 🚀
2021-05-12 18:23:45 +05:30
<!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="What is cache busting?"><meta name="keywords" content="rust, rustlang, rust-lang, cache_buster"><title>cache_buster - 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><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
Deploying to gh-pages from @ 7f1d3a6e7cb29242e52990c82bb1f94993265cb0 🚀
2021-04-08 19:41:32 +05:30
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
Deploying to gh-pages from @ c95063e07429284c1c0f1b501cdd8d5f8fb48090 🚀
2021-07-04 15:10:06 +05:30
<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 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">&#9776;</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">Crate cache_buster</p><div class="block version"><p>Version 0.2.0</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all cache_buster's items</p></a><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#constants">Constants</a></li></ul></div><p class="location"></p><div id="sidebar-vars" data-name="cache_buster" 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" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><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>
Deploying to gh-pages from @ 3cf8828ab80b72037d23f5ce12b5879e44534da3 🚀
2021-07-07 18:00:54 +05:30
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="">cache_buster</a><button id="copy-path" onclick="copy_path(this)">⎘</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">&#x2212;</span>]</a></span><a class="srclink" href="../src/cache_buster/lib.rs.html#7-73" title="goto source code">[src]</a></span></h1><div class="docblock"><h1 id="what-is-cache-busting" class="section-header"><a href="#what-is-cache-busting">What is cache busting?</a></h1>
Deploying to gh-pages from @ d970b7031cd90649e30dc297eb5eba74832153e8 🚀
2021-05-12 18:23:45 +05:30
<p>To optimise network load time, browsers cache static files. Caching
greatly improves performance but how do you inform browsers to
invalidate cache when your files have changed?</p>
<p>Cache busting is a simple but effective solution for this issue. There
are several ways to achieve this but the way this library does this is
by changing file names to include the hash of the files’ contents.</p>
<p>So if you have <code>bundle.js</code>, it will become
<code>bundle.&lt;long-sha256-hash&gt;.js</code>. This lets you set a super long cache age
as, because of the file names changing, the path to the filename, too,
will change. So as far as the browser is concerned, you are trying to load
a file that it doesn’t have. Pretty neat, isn’t it?</p>
<h2 id="example" class="section-header"><a href="#example">Example:</a></h2>
<ul>
<li><code>build.rs</code></li>
</ul>
Deploying to gh-pages from @ 7f1d3a6e7cb29242e52990c82bb1f94993265cb0 🚀
2021-04-08 19:41:32 +05:30
<div class="example-wrap"><pre class="rust rust-example-rendered">
Deploying to gh-pages from @ c95063e07429284c1c0f1b501cdd8d5f8fb48090 🚀
2021-07-04 15:10:06 +05:30
<span class="kw">use</span> <span class="ident">cache_buster::BusterBuilder</span>;
Deploying to gh-pages from @ 7f1d3a6e7cb29242e52990c82bb1f94993265cb0 🚀
2021-04-08 19:41:32 +05:30
Deploying to gh-pages from @ 209682b33c38782a3b8ba451fa29564d585763e0 🚀
2021-07-05 14:51:21 +05:30
<span class="comment">// note: add error checking yourself.</span>
<span class="comment">// println!(&quot;cargo:rustc-env=GIT_process={}&quot;, git_process);</span>
<span class="kw">let</span> <span class="ident">types</span> <span class="op">=</span> <span class="macro">vec!</span>[
<span class="ident">mime::IMAGE_PNG</span>,
<span class="ident">mime::IMAGE_SVG</span>,
<span class="ident">mime::IMAGE_JPEG</span>,
<span class="ident">mime::IMAGE_GIF</span>,
];
Deploying to gh-pages from @ 7f1d3a6e7cb29242e52990c82bb1f94993265cb0 🚀
2021-04-08 19:41:32 +05:30
Deploying to gh-pages from @ 209682b33c38782a3b8ba451fa29564d585763e0 🚀
2021-07-05 14:51:21 +05:30
<span class="kw">let</span> <span class="ident">config</span> <span class="op">=</span> <span class="ident">BusterBuilder::default</span>()
.<span class="ident">source</span>(<span class="string">&quot;./dist&quot;</span>)
.<span class="ident">result</span>(<span class="string">&quot;./prod&quot;</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>();
Deploying to gh-pages from @ 7f1d3a6e7cb29242e52990c82bb1f94993265cb0 🚀
2021-04-08 19:41:32 +05:30
Deploying to gh-pages from @ 209682b33c38782a3b8ba451fa29564d585763e0 🚀
2021-07-05 14:51:21 +05:30
<span class="ident">config</span>.<span class="ident">process</span>().<span class="ident">unwrap</span>();</pre></div>
Deploying to gh-pages from @ d970b7031cd90649e30dc297eb5eba74832153e8 🚀
2021-05-12 18:23:45 +05:30
<ul>
<li><code>main.rs</code>:</li>
</ul>
<p>Module describing runtime compoenet for fetching modified filenames</p>
<p>Add the following tou your program to load the filemap during compiletime:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered">
Deploying to gh-pages from @ c95063e07429284c1c0f1b501cdd8d5f8fb48090 🚀
2021-07-04 15:10:06 +05:30
<span class="kw">use</span> <span class="ident">cache_buster::Files</span>;
<span class="kw">use</span> <span class="ident">cache_buster::CACHE_BUSTER_DATA_FILE</span>;
Deploying to gh-pages from @ d970b7031cd90649e30dc297eb5eba74832153e8 🚀
2021-05-12 18:23:45 +05:30
Deploying to gh-pages from @ 209682b33c38782a3b8ba451fa29564d585763e0 🚀
2021-07-05 14:51:21 +05:30
<span class="kw">let</span> <span class="ident">files</span> <span class="op">=</span> <span class="ident">Files::new</span>(<span class="ident">CACHE_BUSTER_DATA_FILE</span>);
<span class="comment">// the path to the file before setting up for cache busting</span>
<span class="ident">files</span>.<span class="ident">get</span>(<span class="string">&quot;./dist/github.svg&quot;</span>);</pre></div>
Deploying to gh-pages from @ e09a6ad0cb5926735ca85f2ad030c593ff54d7b2 🚀
2021-04-08 20:06:43 +05:30
</div><h2 id="reexports" class="section-header"><a href="#reexports">Re-exports</a></h2>
Deploying to gh-pages from @ 3cf8828ab80b72037d23f5ce12b5879e44534da3 🚀
2021-07-07 18:00:54 +05:30
<table><tr class="import-item"><td><code>pub use processor::<a class="struct" href="processor/struct.BusterBuilder.html" title="struct cache_buster::processor::BusterBuilder">BusterBuilder</a>;</code></td><td class="docblock-short"></td></tr><tr class="import-item"><td><code>pub use processor::<a class="enum" href="processor/enum.NoHashCategory.html" title="enum cache_buster::processor::NoHashCategory">NoHashCategory</a>;</code></td><td class="docblock-short"></td></tr><tr class="import-item"><td><code>pub use filemap::<a class="struct" href="filemap/struct.Files.html" title="struct cache_buster::filemap::Files">Files</a>;</code></td><td class="docblock-short"></td></tr></table><h2 id="modules" class="section-header"><a href="#modules">Modules</a></h2>
Deploying to gh-pages from @ 23bf39b328b2b04c4971b3da8412778538b05d60 🚀
2021-04-10 17:52:31 +05:30
<table><tr class="module-item"><td><a class="mod" href="filemap/index.html" title="cache_buster::filemap mod">filemap</a></td><td class="docblock-short"><p>Module describing runtime compoenet for fetching modified filenames</p>
</td></tr><tr class="module-item"><td><a class="mod" href="processor/index.html" title="cache_buster::processor mod">processor</a></td><td class="docblock-short"><p>Module describing file processor that changes filenames to setup cache-busting</p>
Deploying to gh-pages from @ 09fbbe186c04218627ee5ea6f2baa8f72a6a6e7f 🚀
2021-04-11 22:56:05 +05:30
</td></tr></table><h2 id="constants" class="section-header"><a href="#constants">Constants</a></h2>
Deploying to gh-pages from @ 3c3b61aebfcdd403ff2b38bb42ad37e3daf9af49 🚀
2021-04-30 20:40:27 +05:30
<table><tr class="module-item"><td><a class="constant" href="constant.CACHE_BUSTER_DATA_FILE.html" title="cache_buster::CACHE_BUSTER_DATA_FILE constant">CACHE_BUSTER_DATA_FILE</a></td><td class="docblock-short"><p>file to which filemap is written during compilation
include this to <code>.gitignore</code></p>
Deploying to gh-pages from @ c95063e07429284c1c0f1b501cdd8d5f8fb48090 🚀
2021-07-04 15:10:06 +05:30
</td></tr></table></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="cache_buster" data-search-index-js="../search-index.js" data-search-js="../search.js"></div>
Deploying to gh-pages from @ d970b7031cd90649e30dc297eb5eba74832153e8 🚀
2021-05-12 18:23:45 +05:30
<script src="../main.js"></script></body></html>
Reference in a new issue Copy permalink