toxblh/podcasts
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Added some doc comments in hammond-data/src/utils.rs.

Browse Source
This commit is contained in:
Jordan Petridis 2017-11-27 05:25:16 +02:00
parent cb65782829
commit c4030e51df
No known key found for this signature in database
GPG Key ID: CEABAD9F5683B9A6
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
hammond-data/src/utils.rs
View File

@ -31,7 +31,6 @@ fn checker_helper(ep: &mut Episode) {
}
}
// TODO: Write unit test.
fn played_cleaner() -> Result<()> {
let episodes = dbqueries::get_played_episodes()?;
@ -56,6 +55,7 @@ fn played_cleaner() -> Result<()> {
Ok(())
}
/// Check `ep.local_uri` field and delete the file it points to.
pub fn delete_local_content(ep: &mut Episode) -> Result<()> {
if ep.local_uri().is_some() {
let uri = ep.local_uri().unwrap().to_owned();
@ -78,12 +78,21 @@ pub fn delete_local_content(ep: &mut Episode) -> Result<()> {
Ok(())
}
/// Database cleaning tasks.
///
/// Runs a download checker which looks for `Episode.local_uri` entries that
/// doesn't exist and sets them to None
///
/// Runs a cleaner for played Episode's that are pass the lifetime limit and
/// scheduled for removal.
pub fn checkup() -> Result<()> {
download_checker()?;
played_cleaner()?;
Ok(())
}
/// Remove fragment identifiers and query pairs from a URL
/// If url parsing fails, return's a trimmed version of the original input.
pub fn url_cleaner(s: &str) -> String {
// Copied from the cookbook.
// https://rust-lang-nursery.github.io/rust-cookbook/net.html