Error type for BusterBuilder
+UninitializedField(&'static str)Uninitialized field
+ValidationError(String)Custom validation error
+impl Debug for BusterBuilderError[src]impl Display for BusterBuilderError[src]impl Error for BusterBuilderError[src]pub fn source(&self) -> Option<&(dyn Error + 'static)>1.30.0[src]pub fn backtrace(&self) -> Option<&Backtrace>[src]pub fn description(&self) -> &str1.0.0[src]pub fn cause(&self) -> Option<&dyn Error>1.0.0[src]impl From<String> for BusterBuilderError[src]impl From<UninitializedFieldError> for BusterBuilderError[src]impl RefUnwindSafe for BusterBuilderError[src]impl Send for BusterBuilderError[src]impl Sync for BusterBuilderError[src]impl Unpin for BusterBuilderError[src]impl UnwindSafe for BusterBuilderError[src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T> ToString for T where
T: Display + ?Sized, [src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]+use cache_buster::BusterBuilder; + +fn main() { + // note: add error checking yourself. + // println!("cargo:rustc-env=GIT_HASH={}", git_hash); + let types = vec![ + mime::IMAGE_PNG, + mime::IMAGE_SVG, + mime::IMAGE_JPEG, + mime::IMAGE_GIF, + ]; + + let config = BusterBuilder::default() + .source("./dist") + .result("./prod") + .mime_types(types) + .copy(true) + .follow_links(true) + .build() + .unwrap(); + + config.init().unwrap(); + config.hash().unwrap(); +}
| Buster | |
| BusterBuilder | Builder for |
| BusterBuilderError | Error type for BusterBuilder + |
impl Buster[src]pub fn init(&self) -> Result<(), Error>[src]pub fn try_hash(&self) -> Result<(), Error>[src]pub fn hash(&self) -> Result<(), Error>[src]impl RefUnwindSafe for Buster[src]impl Send for Buster[src]impl Sync for Buster[src]impl Unpin for Buster[src]impl UnwindSafe for Buster[src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+pub fn to_owned(&self) -> T[src]pub fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]Builder for Buster.
impl BusterBuilder[src]pub fn source<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self[src]pub fn mime_types(&mut self, value: Vec<Mime>) -> &mut Self[src]pub fn result<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self[src]pub fn copy(&mut self, value: bool) -> &mut Self[src]pub fn follow_links(&mut self, value: bool) -> &mut Self[src]pub fn build(&self) -> Result<Buster, BusterBuilderError>[src]impl Clone for BusterBuilder[src]fn clone(&self) -> BusterBuilder[src]pub fn clone_from(&mut self, source: &Self)1.0.0[src]impl Default for BusterBuilder[src]impl RefUnwindSafe for BusterBuilder[src]impl Send for BusterBuilder[src]impl Sync for BusterBuilder[src]impl Unpin for BusterBuilder[src]impl UnwindSafe for BusterBuilder[src]impl<T> Any for T where
T: 'static + ?Sized, [src]impl<T> Borrow<T> for T where
T: ?Sized, [src]impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]impl<T> From<T> for T[src]impl<T, U> Into<U> for T where
U: From<T>, [src]impl<T> Same<T> for Ttype Output = TShould always be Self
impl<T> ToOwned for T where
T: Clone, [src]type Owned = TThe resulting type after obtaining ownership.
+pub fn to_owned(&self) -> T[src]pub fn clone_into(&self, target: &mut T)[src]impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]type Error = InfallibleThe type returned in the event of a conversion error.
+pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]| "+""+(item.is_alias===true?(""+item.alias+" - see "):"")+item.displayPath+""+name+" | "+""+""+item.desc+" |
"+code.outerHTML+" |
fn:) to \
+ restrict the search to a given item kind.","Accepted kinds are: fn, mod, struct, \
+ enum, trait, type, macro, \
+ and const.","Search functions by type signature (e.g., vec -> usize or \
+ * -> vec)","Search multiple things at once by splitting your query with comma (e.g., \
+ str,u8 or String,struct:Vec,test)","You can look for items with an exact name by putting double quotes around \
+ your request: \"string\"","Look for items inside another one by searching for a path: vec::Vec",].map(x=>""+x+"
").join("");var div_infos=document.createElement("div");addClass(div_infos,"infos");div_infos.innerHTML="Buster.",null,null],[11,"source","","",0,[[["into",8],["string",3]]]],[11,"mime_types","","",0,[[["vec",3],["mime",3]]]],[11,"result","","",0,[[["into",8],["string",3]]]],[11,"copy","","",0,[[["bool",15]]]],[11,"follow_links","","",0,[[["bool",15]]]],[11,"build","","Builds a new Buster.",0,[[],[["result",4],["buster",3],["busterbuildererror",4]]]],[4,"BusterBuilderError","","Error type for BusterBuilder",null,null],[13,"UninitializedField","","Uninitialized field",1,null],[13,"ValidationError","","Custom validation error",1,null],[11,"init","","",2,[[],[["result",4],["error",3]]]],[11,"try_hash","","",2,[[],[["result",4],["error",3]]]],[11,"hash","","",2,[[],[["result",4],["error",3]]]],[11,"from","","",2,[[]]],[11,"into","","",2,[[]]],[11,"to_owned","","",2,[[]]],[11,"clone_into","","",2,[[]]],[11,"borrow","","",2,[[]]],[11,"borrow_mut","","",2,[[]]],[11,"try_from","","",2,[[],["result",4]]],[11,"try_into","","",2,[[],["result",4]]],[11,"type_id","","",2,[[],["typeid",3]]],[11,"from","","",0,[[]]],[11,"into","","",0,[[]]],[11,"to_owned","","",0,[[]]],[11,"clone_into","","",0,[[]]],[11,"borrow","","",0,[[]]],[11,"borrow_mut","","",0,[[]]],[11,"try_from","","",0,[[],["result",4]]],[11,"try_into","","",0,[[],["result",4]]],[11,"type_id","","",0,[[],["typeid",3]]],[11,"from","","",1,[[]]],[11,"into","","",1,[[]]],[11,"to_string","","",1,[[],["string",3]]],[11,"borrow","","",1,[[]]],[11,"borrow_mut","","",1,[[]]],[11,"try_from","","",1,[[],["result",4]]],[11,"try_into","","",1,[[],["result",4]]],[11,"type_id","","",1,[[],["typeid",3]]],[11,"from","","",1,[[["uninitializedfielderror",3]]]],[11,"from","","",1,[[["string",3]]]],[11,"clone","","",2,[[],["buster",3]]],[11,"clone","","",0,[[],["busterbuilder",3]]],[11,"default","","",0,[[]]],[11,"fmt","","",2,[[["formatter",3]],["result",6]]],[11,"fmt","","",1,[[["formatter",3]],["result",6]]],[11,"fmt","","",1,[[["formatter",3]],["result",6]]]],"p":[[3,"BusterBuilder"],[4,"BusterBuilderError"],[3,"Buster"]]}\
+}');
+addSearchOptions(searchIndex);initSearch(searchIndex);
\ No newline at end of file
diff --git a/settings.css b/settings.css
new file mode 100644
index 0000000..6709865
--- /dev/null
+++ b/settings.css
@@ -0,0 +1 @@
+.setting-line{padding:5px;position:relative;}.setting-line>div{display:inline-block;vertical-align:top;font-size:17px;padding-top:2px;}.setting-line>.title{font-size:19px;width:100%;max-width:none;border-bottom:1px solid;}.toggle{position:relative;display:inline-block;width:45px;height:27px;margin-right:20px;}.toggle input{opacity:0;position:absolute;}.select-wrapper{float:right;position:relative;height:27px;min-width:25%;}.select-wrapper select{appearance:none;-moz-appearance:none;-webkit-appearance:none;background:none;border:2px solid #ccc;padding-right:28px;width:100%;}.select-wrapper img{pointer-events:none;position:absolute;right:0;bottom:0;background:#ccc;height:100%;width:28px;padding:0px 4px;}.select-wrapper select option{color:initial;}.slider{position:absolute;cursor:pointer;top:0;left:0;right:0;bottom:0;background-color:#ccc;-webkit-transition:.3s;transition:.3s;}.slider:before{position:absolute;content:"";height:19px;width:19px;left:4px;bottom:4px;background-color:white;-webkit-transition:.3s;transition:.3s;}input:checked+.slider{background-color:#2196F3;}input:focus+.slider{box-shadow:0 0 0 2px #0a84ff,0 0 0 6px rgba(10,132,255,0.3);}input:checked+.slider:before{-webkit-transform:translateX(19px);-ms-transform:translateX(19px);transform:translateX(19px);}.setting-line>.sub-settings{padding-left:42px;width:100%;display:block;}
\ No newline at end of file
diff --git a/settings.html b/settings.html
new file mode 100644
index 0000000..96ff646
--- /dev/null
+++ b/settings.html
@@ -0,0 +1,7 @@
+1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 + 10 + 11 + 12 + 13 + 14 + 15 + 16 + 17 + 18 + 19 + 20 + 21 + 22 + 23 + 24 + 25 + 26 + 27 + 28 + 29 + 30 + 31 + 32 + 33 + 34 + 35 + 36 + 37 + 38 + 39 + 40 + 41 + 42 + 43 + 44 + 45 + 46 + 47 + 48 + 49 + 50 + 51 + 52 + 53 + 54 + 55 + 56 + 57 + 58 + 59 + 60 + 61 + 62 + 63 + 64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +
+/* +* Copyright (C) 2021 Aravinth Manivannan <realaravinth@batsense.net> +* +* Use of this source code is governed by the Apache 2.0 and/or the MIT +* License. +*/ + +//! ```rust +//! use cache_buster::BusterBuilder; +//! +//! fn main() { +//! // note: add error checking yourself. +//! // println!("cargo:rustc-env=GIT_HASH={}", git_hash); +//! let types = vec![ +//! mime::IMAGE_PNG, +//! mime::IMAGE_SVG, +//! mime::IMAGE_JPEG, +//! mime::IMAGE_GIF, +//! ]; +//! +//! let config = BusterBuilder::default() +//! .source("./dist") +//! .result("./prod") +//! .mime_types(types) +//! .copy(true) +//! .follow_links(true) +//! .build() +//! .unwrap(); +//! +//! config.init().unwrap(); +//! config.hash().unwrap(); +//! } +//! ``` + +use std::fs; +use std::io::Error; +use std::path::Path; + +use derive_builder::Builder; +use walkdir::WalkDir; + +#[derive(Debug, Clone, Builder)] +pub struct Buster { + // source directory + #[builder(setter(into))] + source: String, + // mime_types for hashing + mime_types: Vec<mime::Mime>, + // directory for writing results + #[builder(setter(into))] + result: String, + // copy other non-hashed files from source dire to result dir? + copy: bool, + follow_links: bool, +} + +impl Buster { + pub fn init(&self) -> Result<(), Error> { + let res = Path::new(&self.result); + if res.exists() { + fs::remove_dir_all(&self.result).unwrap(); + } + + fs::create_dir(&self.result).unwrap(); + self.create_dir_structure(Path::new(&self.source))?; + Ok(()) + } + + fn hasher(payload: &str) -> String { + use data_encoding::HEXUPPER; + use sha2::{Digest, Sha256}; + let mut hasher = Sha256::new(); + hasher.update(payload); + HEXUPPER.encode(&hasher.finalize()) + } + + // if mime types are common, then you shoud be fine using this + // use [hash] when when they aren't + // + // doesn't process files for which mime is not resolved + pub fn try_hash(&self) -> Result<(), Error> { + for entry in WalkDir::new(&self.source) + .follow_links(self.follow_links) + .into_iter() + { + let entry = entry?; + let path = entry.path(); + let path = Path::new(&path); + + for mime_type in self.mime_types.iter() { + if let Some(file_mime) = mime_guess::from_path(path).first() { + if &file_mime == mime_type { + let contents = Self::read_to_string(&path).unwrap(); + let hash = Self::hasher(&contents); + let new_name = format!( + "{}.{}.{}", + path.file_stem().unwrap().to_str().unwrap(), + hash, + path.extension().unwrap().to_str().unwrap() + ); + // println!("{}", &new_name); + self.copy(path, &new_name); + // let data = fs::copy(path, new_name); + } + } + } + } + + Ok(()) + } + + // panics when mimetypes are detected. This way you'll know which files are ignored + // from processing + pub fn hash(&self) -> Result<(), Error> { + for entry in WalkDir::new(&self.source) + .follow_links(self.follow_links) + .into_iter() + { + let entry = entry?; + + let path = entry.path(); + if !path.is_dir() { + let path = Path::new(&path); + + for mime_type in self.mime_types.iter() { + let file_mime = mime_guess::from_path(path) + .first() + .expect(&format!("couldn't resolve MIME for file: {:?}", &path)); + if &file_mime == mime_type { + let contents = Self::read_to_string(&path).unwrap(); + let hash = Self::hasher(&contents); + let new_name = format!( + "{}.{}.{}", + path.file_stem().unwrap().to_str().unwrap(), + hash, + path.extension().unwrap().to_str().unwrap() + ); + self.copy(path, &new_name); + } + } + } + } + + Ok(()) + } + + fn read_to_string(path: &Path) -> Result<String, Error> { + use std::fs::File; + use std::io::{BufRead, BufReader}; + + let input = File::open(path)?; + let buffered = BufReader::new(input); + + let mut res = String::new(); + for line in buffered.lines() { + res.push_str(&line?) + } + + Ok(res) + } + + fn copy(&self, source: &Path, name: &str) { + let rel_location = source.strip_prefix(&self.source).unwrap().parent().unwrap(); + let destination = Path::new(&self.result).join(rel_location).join(name); + fs::copy(source, &destination).unwrap(); + } + + fn create_dir_structure(&self, path: &Path) -> Result<(), Error> { + for entry in WalkDir::new(&path) + .follow_links(self.follow_links) + .into_iter() + { + let entry = entry?; + let entry_path = entry.path(); + let entry_path = Path::new(&entry_path); + + if entry_path.is_dir() && path != entry_path { + Self::create_dir_structure(&self, entry_path)?; + } else { + if entry_path.is_dir() { + let rel_location = entry_path.strip_prefix(&self.source).unwrap(); + let destination = Path::new(&self.result).join(rel_location); + if !destination.exists() { + fs::create_dir(destination)? + } + } + } + } + Ok(()) + } +} +