FrozenCore

Custom implementations and core utilities for frozen codebases.

Index

• setup
• ffile
• fmmap
• error
• hints
• notes

Setup

Add following to your Cargo.toml,

[dependencies]
frozen-core = { version = "0.0", 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", default-features = false, features = ["ffile"] }

FrozenFile is currently available on the following platforms,

For example usage, refer to example

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", default-features = false, features = ["fmmap"] }

FrozenMMap is currently available on the following platforms,

For example usage, refer to example

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", 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", 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.