https://github.com/fralonra/aict

Generaties auto-incrementing unique IDs
https://github.com/fralonra/aict

autoincrement id id-generation

Last synced: 7 months ago
JSON representation

Generaties auto-incrementing unique IDs

• Host: GitHub
• URL: https://github.com/fralonra/aict
• Owner: fralonra
• License: mit
• Created: 2023-09-26T08:18:13.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-10-11T10:47:49.000Z (over 2 years ago)
• Last Synced: 2025-03-28T17:17:08.060Z (about 1 year ago)
• Topics: autoincrement, id, id-generation
• Language: Rust
• Homepage:
• Size: 6.84 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# aict

[![Latest version](https://img.shields.io/crates/v/aict.svg)](https://crates.io/crates/aict)

[![Documentation](https://docs.rs/aict/badge.svg)](https://docs.rs/aict)

![MIT](https://img.shields.io/badge/license-MIT-blue.svg)

`aict` is designed for generating auto-incrementing unique IDs of a specific type.

It provides built-in support for integer types (`i8`, `i16`, `i32`, `i64`, `isize`, `u8`, `u16`, `u32`, `u64`, `usize`). However, you can add support for your own types by implementing the [`Aictable`](https://docs.rs/aict/latest/aict/struct.Aictable.html) trait.

## Examples

```rust

use aict::Factory;

// Creates a new Factory for u32 IDs.

let mut factory = Factory::::builder()

    // Sets the initial value for the IDs.

    // For built-in types, the default value is the minimum value.

    // .initial_value(1)

    // Whether to loop back to the initial value after reaching the maximum value.

    // Default is false.

    // .looping(true)

    // Whether to rewind to the position of the latest removed ID when generating the next ID.

    // Default is false.

    // .rewind(true)

    .build();

// Generates some IDs.

assert_eq!(factory.next().unwrap(), 0);

assert_eq!(factory.next().unwrap(), 1);

// Removes an ID so that it can be reused in the future.

factory.remove(0);

// Manually marks an ID as used.

assert!(factory.take_up(2).is_ok());

// Since 2 was taken up, the next available ID is 3.

// However, if rewind is set to true, the next ID is 0.

assert_eq!(factory.next().unwrap(), 3);

```

## Similiar Crates

- [serial_int](https://crates.io/crates/serial_int)

- [autoincrement](https://crates.io/crates/autoincrement)