static-id 0.3.1

A memory-efficient library for handling interned identifiers
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

# StaticId


This library provides an extremely memory-efficient implementation of `StaticId` for handling interned identifiers with optimal performance.

## Features

- `StaticId`: A highly optimized, interned identifier type combining a code and a venue.
- Exceptional memory efficiency: Each `StaticId` is represented by a single 64-bit pointer.
- Ultra-fast comparisons: Equality checks and hashing operations only compare 8 bytes, regardless of the actual string length.
- Lazy evaluation: The actual string data is only accessed during serialization.

## Limitations

- The bound of `code` and `venue` are fixed: For StaticIdNxM, the maximum length of `code` and `venue` is N and M respectively. The exceeding characters will be truncated.
- The given structs are:
  * StaticId16x0
  * StaticId16x16
  * StaticId16x32
  * StaticId16x64
  * StaticId32x0
  * StaticId32x16
  * StaticId32x32 (=StaticId)
  * StaticId32x64
  * StaticId64x0
  * StaticId64x16
  * StaticId64x32
  * StaticId64x64

## Usage


`StaticId` combines a `Code` (up to 32 bytes) and a `Venue` (up to 16 bytes) into an interned identifier:

```rust
use crate::StaticId;

// Create from string slices
let id = StaticId::from_str("AAPL", "NASDAQ");

// Create from byte slices
let id_bytes = StaticId::from_bytes(b"AAPL", b"NASDAQ");

assert_eq!(id.get_id().code.as_str(), "AAPL");
assert_eq!(id.get_id().venue.as_str(), "NASDAQ");

// Get the length of the combined code and venue
println!("Length: {}", id.len());  // Outputs the sum of code and venue lengths

// Get the number of unique StaticIds in the cache
println!("Cache size: {}", StaticId::cache_len());

// Fast equality check (compares only 8 bytes)
let id2 = StaticId::from_str("AAPL", "NASDAQ");
assert_eq!(id, id2);

// Memory usage
println!("Size of StaticId: {} bytes", std::mem::size_of::<StaticId>());  // Outputs: 8 bytes
```

## Installation


Add this to your `Cargo.toml`:

```toml
[dependencies]
static_id = "0.1"
```

## Performance Considerations


- The first creation of a `StaticId` with unique content will involve allocation and interning. Subsequent creations of `StaticId`s with the same content will reuse the interned value.
- While creation and interning have some overhead, subsequent operations like equality checks and hashing are extremely fast.
- The library uses a global cache for interning, which is protected by a mutex. In highly concurrent scenarios, this could potentially become a bottleneck.
- The `cache_len()` method allows you to monitor the size of the intern cache, which can be useful for understanding memory usage in your application.

## License


This project is licensed under [LICENSE NAME] - see the [LICENSE.md](LICENSE.md) file for details.

## Contributing


Contributions are welcome! Please feel free to submit a Pull Request.