sector 0.1.0

A stateful vector implementation that provides different memory management behaviors through Rust traits and state machines.
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

# sector

A **stateful vector implementation** that provides different memory management behaviors through Rust traits and state machines.

![Rust](https://img.shields.io/badge/Rust-1.70%2B-orange)
[![MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE-MIT)
[![Apache 2.0](https://img.shields.io/badge/License-APACHE%202.0-blue.svg)](./LICENSE-MIT)
[![Build Status](https://img.shields.io/github/actions/workflow/status/Dari-OS/sector/.github%2Fworkflows%2Frust.yml)](https://github.com/Dari-OS/sector/actions)

---

## Table of Contents

- [About](#about)
- [Features](#features)
- [States](#states)
- [Usage](#usage)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [Roadmap](#roadmap)
- [Licenses](#license)

---

## About

**sector** is a Rust library that provides a stateful vector structure (`Sector<State, T>`) with choosable memory allocation strategies.  
Unlike `Vec<T>`, it allows developers to control how memory grows/shrinks.

> [!NOTE]
> This library is under **active development**. Expect changes and optimizations.

## Features

- [x] **Stateful Memory Management** – Control memory allocation behavior dynamically.

- [x] **Lightweight & Fast** – Minimal overhead while allowing full customization.

- [x] **No Std Support** – Support for `#![no_std]` environments by default.

## States

Sector has 6 different states:

- [`Normal`] Acts like the normal `std::vec::Vec<T>`.
- [`Dynamic`] Grows the internal capacity by a factor of 2. Shrinks to 3/4 of the original capacity
- [`Fixed`] Is not able to grow nor shrink. Returns `false` if the capacity is full and you try to add elements.
- [`Locked`] Does not allow to add or remove elements, regardless of the inner capacity.
- [`Manual`] Requires you to grow and shrink the inner capacity manually.
- [`Tight`] The inner capacity is exactly as large as the length

> [!WARNING]
> Be careful!
> [**Zero Sized**](https://doc.rust-lang.org/nomicon/exotic-sizes.html) Types are treated differently by each state.
> Refer to the specific documentation of each state to get more information.

[`Normal`]: ./src/states/normal.rs#L7
[`Dynamic`]: ./src/states/dynamic.rs#L23
[`Fixed`]: ./src/states/fixed.rs#L28
[`Locked`]: ./src/states/locked.rs#L22
[`Manual`]: ./src/states/manual.rs#L18
[`Tight`]: ./src/states/tight.rs#L23

## Usage

Add `sector` as a dependency in your `Cargo.toml`:

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

### Basic Example

```rust
use sector::{states::Normal, Sector};

fn main() {
    let mut sec: Sector<Normal, _> = Sector::new();
    sec.push(10);
    sec.push(20);

    // Access elements
    println!("First element: {:?}", sec.get(0));
}
```

## Documentation

Generate docs locally:

```sh
cargo doc --open
```

Or visit the documentation online:

[docs.rs](https://docs.rs/sector/latest/sector/)

## Contributing

Contributions are welcome!

## Roadmap

- [x] Basic stateful vector implementation
- [x] Capacity management
- [x] `no_std` support
- [ ] Benchmarks & optimizations

## License

This project is dual licensed:

- Apache License, Version 2.0
  ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license
  ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)