frozen-core 0.0.4

Custom implementations and core utilities for frozen codebases
Documentation 
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

# FrozenCore

Custom implementations and core utilities for frozen codebases.

## Index

- [`ff`](#frozenfile)
- [`fm`](#frozenmmap)
- [`fe`](#frozenerror)
- [`hints`](#hints)
- [`notes`](#notes)

## FrozenFile

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

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

```toml
[dependencies]
frozen-core = { version = "0.0.4", features = ["ff"] }
```

`FF` is currently available for following platforms,

| Platform                              | Support |
|---------------------------------------|:-------:|
| `aarch64-unknown-linux-gnu`           | ✅      |
| `x86_64-unknown-linux-gnu`            | ✅      |
| `aarch64-pc-windows-msvc`             | ❌      |
| `x86_64-pc-windows-msvc`              | ❌      |
| `aarch64-apple-darwin`                | ✅      |
| `x86_64-apple-darwin`                 | ✅      |

For Example usage, refer to [example](./examples/ff.rs)

## FrozenMMap

`FrozenMMap` is a custom implementation of `mmap`.

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

```toml
[dependencies]
frozen-core = { version = "0.0.4", features = ["fm"] }
```

`FM` is currently available for following platforms,

| Platform                              | Support |
|---------------------------------------|:-------:|
| `aarch64-unknown-linux-gnu`           | ✅      |
| `x86_64-unknown-linux-gnu`            | ✅      |
| `aarch64-pc-windows-msvc`             | ❌      |
| `x86_64-pc-windows-msvc`              | ❌      |
| `aarch64-apple-darwin`                | ✅      |
| `x86_64-apple-darwin`                 | ✅      |

For Example usage, refer to [example](./examples/fm.rs)

## FrozenError

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

The `fe` module is available by deafult. Add it as a dependency in your `Cargo.toml`:

```toml
[dependencies]
frozen-core = "0.0.4"
```

## Hints

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

The `hints` module is available by deafult. Add it as a dependency in your `Cargo.toml`:

```toml
[dependencies]
frozen-core = "0.0.4"
```

## Notes

> [!IMPORTANT]
> `frozen-core` is primarily created for [frozen-lab](https://github.com/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](LICENSE-APACHE) and [LICENSE-MIT](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.