FrozenCore

Custom implementations and core utilities for frozen codebases.

Index

• usage
• ffile
• fmmap
• error
• hints
• notes

Usage

Add following to your Cargo.toml,

[dependencies]
frozen-core = { version = "0.0.6", default-features = true }

[!TIP] All the features available by default. To disable this, set default-features = false

FrozenFile

FrozenFile is a custom implementation of std::fs::File.

To use the ffile module, add it as a dependency in your Cargo.toml:

[dependencies]
frozen-core = { version = "0.0.6", default-features = false, features = ["ffile"] }

FrozenFile is currently available on the following platforms,

See below for example usage,

use frozen_core::ffile::FrozenFile;
use tempfile::tempdir;

fn main() {
    let dir = tempdir().expect("tmp");
    let path = dir.path().join("standalone.bin");
  
    let file = FrozenFile::new(path.clone(), 0x20, 7).expect("file");
    assert!(FrozenFile::exists(&path).expect("exists"));
  
    file.grow(0x20).expect("grow");
    assert!(file.length() >= 0x40);
  
    file.delete().expect("delete");
    assert!(!FrozenFile::exists(&path).expect("exists after delete"));
}

refer to example for more details

FrozenMMap

FrozenMMap is a custom implementation of mmap.

To use the fmmap module, add it as a dependency in your Cargo.toml:

[dependencies]
frozen-core = { version = "0.0.6", default-features = false, features = ["fmmap"] }

FrozenMMap is currently available on the following platforms,

See below for example usage,

use frozen_core::{ffile::FrozenFile, fmmap::{FrozenMMap, FMCfg}};
use tempfile::tempdir;

fn main() {   
    let dir = tempdir().expect("tmp dir");
    let path = dir.path().join("example.bin");
   
    let file = FrozenFile::new(path, 0x10, 1).expect("file");
    let mmap = FrozenMMap::new(file, FMCfg::new(1)).expect("mmap");
    let (_, epoch) = mmap.with_write::<u64, _>(0, |v| *v = 0xDEADC0DE).expect("write");
   
    match mmap.wait_for_durability(epoch) {
        Ok(_) => {
            let value = mmap.with_read::<u64, u64>(0, |v| *v).unwrap();
            assert_eq!(value, 0xDEADC0DE);
        }
        Err(e) => panic!("{e}"),
    }
}

refer to example for more details.

FrozenErr

FRes & FErr are custom implementation's for result and error propogation.

To use the error module, add it as a dependency in your Cargo.toml:

[dependencies]
frozen-core = { version = "0.0.6", default-features = false, features = ["error"] }

Hints

The hints module provides stable friendly implementations of likely and unlikely branch hints functions.

To use the hints module, add it as a dependency in your Cargo.toml:

[dependencies]
frozen-core = { version = "0.0.6", default-features = false, features = ["hints"] }

Notes

[!IMPORTANT] frozen-core is primarily created for frozen-lab projects. External use is discouraged, but not prohibited, given you asume all the risks.

This project is licensed under the Apache-2.0 and MIT License. See the LICENSE-APACHE and LICENSE-MIT file for more details.

Contributions are welcome! Please feel free to submit a PR or open an issue if you have any feedback or suggestions.