libcachebust

Crates.iolibcachebust
lib.rslibcachebust
version0.3.0
sourcesrc
created_at2023-10-16 18:07:25.334264
updated_at2023-10-16 18:53:24.878318
descriptionCompiletime cache-busting web applications written in rust
homepagehttps://git.batsense.net/realaravinth/libcachebust
repositoryhttps://git.batsense.net/realaravinth/libcachebust
max_upload_size
id1004968
size138,328
Aravinth Manivannan (realaravinth)

documentation

README

A photo of Spock showing the Vulkan greeting

libcachebust

May your cache live long and prosper!

status-badge

What is cache busting?

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?

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.

So if you have bundle.js, it will become bundle.<long-sha256-hash>.js. 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?

Features

  • SHA-256 based name generation during compile-time
  • Processes files based on provided MIME filters
  • Exclude certain files from processing based on file extensions and/or file paths
  • Exposes modified names to program during runtime
  • Route prefixes(optional)

Usage:

Add this to your Cargo.toml:

libcachebust = 0.2

Examples:

Commit count: 0

cargo fmt