xet-core-structures 1.5.2

Core data structures including MerkleHash, metadata shards, and Xorb objects.
Documentation
use std::ffi::OsStr;
use std::ops::Deref;
use std::path::Path;
use std::time::Duration;

use lazy_static::lazy_static;
use regex::Regex;
use uuid::Uuid;

use crate::merklehash::MerkleHash;

lazy_static! {
    static ref MERKLE_DB_FILE_PATTERN: Regex = Regex::new(r"^(?P<hash>[0-9a-fA-F]{64})\.mdb$").unwrap();
}

/// Parses a shard filename.  If the filename matches the shard filename pattern,
/// then Some(hash) is returned, where hash is the XORB hash of the merkledb file.  
/// If the filename does not match, None is returned.
#[inline]
pub fn parse_shard_filename<P: AsRef<Path>>(path: P) -> Option<MerkleHash> {
    let path: &Path = path.as_ref();
    let filename = path.file_name()?;

    let filename = filename.to_str().unwrap_or_default();

    MERKLE_DB_FILE_PATTERN
        .captures(filename)
        .map(|capture| MerkleHash::from_hex(capture.name("hash").unwrap().as_str()).unwrap())
}

#[inline]
pub fn truncate_hash(hash: &MerkleHash) -> u64 {
    hash.deref()[0]
}

pub fn shard_file_name(hash: &MerkleHash) -> String {
    format!("{}.mdb", hash.hex())
}

pub fn temp_shard_file_name() -> String {
    let uuid = Uuid::new_v4();
    format!(".{uuid}.mdb_temp")
}

pub fn is_temp_shard_file(p: &Path) -> bool {
    p.file_name()
        .unwrap_or_else(|| OsStr::new(""))
        .to_str()
        .unwrap_or("")
        .ends_with("mdb_temp")
}

pub fn shard_expiry_time(shard_valid_for: Duration) -> u64 {
    use std::ops::Add;

    std::time::SystemTime::now()
        .add(shard_valid_for)
        .duration_since(std::time::UNIX_EPOCH)
        .unwrap_or_default()
        .as_secs()
}

#[cfg(test)]
mod tests {
    use super::super::shard_format::test_routines::rng_hash;
    use super::*;

    #[test]
    fn test_regex() {
        let mh = rng_hash(0);

        assert!(parse_shard_filename(format!("/Users/me/temp/{}.mdb", mh.hex())).is_some());
        assert!(parse_shard_filename(format!("{}.mdb", mh.hex())).is_some());
        assert!(parse_shard_filename(format!("other_{}.mdb", mh.hex())).is_none());
    }
}