# fangfengxiang/revid-engine architecture

> Architecture diagram of the GitHub repository fangfengxiang/revid-engine, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/fangfengxiang/revid-engine
- Repository: https://github.com/fangfengxiang/revid-engine

## Overview

RevIdEngine is an in-process Go library for generating distributed IDs through two strategies: segmented range allocation and a time-based Snowflake variant. A caller constructs a generator with the corresponding seed, then requests numeric IDs or encoded strings. Segmented generation fetches ranges through a provider; Snowflake resolves a node ID and epoch. Both support pre-allocation, post-allocation, and string-encoding middleware. The source excerpts establish these runtime relationships; README capabilities not visible in sampled code are not expanded into speculative components.

Main entry points: [`snowflake.go`](https://github.com/fangfengxiang/revid-engine/blob/main/snowflake.go) (Snowflake generator), [`segmented.go`](https://github.com/fangfengxiang/revid-engine/blob/main/segmented.go) (Segmented generator), [`revid.go`](https://github.com/fangfengxiang/revid-engine/blob/main/revid.go) (Generator contract)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["Public API"]
  node_generator_contract["Generator contract<br/>[revid.go]"]
  node_numeric_result["Numeric ID"]
  node_string_result["Encoded ID"]
end

subgraph group_strategies["Generation Strategies"]
  node_segmented["Segmented generator<br/>[segmented.go]"]
  node_snowflake["Snowflake generator<br/>[snowflake.go]"]
end

subgraph group_extensions["Providers &amp; Middleware"]
  node_range_provider["Range provider<br/>[revid.go]"]
  node_node_resolver["Node resolver<br/>[revid.go]"]
  node_epoch_resolver["Epoch resolver<br/>[snowflake.go]"]
  node_middleware["Middleware options<br/>[revid.go]"]
end

node_caller(("Library caller"))

node_caller -->|"uses"| node_generator_contract
node_generator_contract -->|"constructs via"| node_segmented
node_generator_contract -->|"constructs via"| node_snowflake
node_segmented -->|"fetches ranges"| node_range_provider
node_snowflake -->|"resolves node"| node_node_resolver
node_snowflake -->|"resolves epoch"| node_epoch_resolver
node_segmented -->|"runs hooks"| node_middleware
node_snowflake -->|"runs hooks"| node_middleware
node_segmented -->|"returns numeric ID"| node_numeric_result
node_snowflake -->|"returns numeric ID"| node_numeric_result
node_segmented -->|"encodes ID"| node_string_result
node_snowflake -->|"encodes ID"| node_string_result

click node_generator_contract "https://github.com/fangfengxiang/revid-engine/blob/main/revid.go"
click node_segmented "https://github.com/fangfengxiang/revid-engine/blob/main/segmented.go"
click node_snowflake "https://github.com/fangfengxiang/revid-engine/blob/main/snowflake.go"
click node_range_provider "https://github.com/fangfengxiang/revid-engine/blob/main/revid.go"
click node_node_resolver "https://github.com/fangfengxiang/revid-engine/blob/main/revid.go"
click node_epoch_resolver "https://github.com/fangfengxiang/revid-engine/blob/main/snowflake.go"
click node_middleware "https://github.com/fangfengxiang/revid-engine/blob/main/revid.go"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_generator_contract,node_numeric_result,node_string_result toneBlue
class node_segmented,node_snowflake toneAmber
class node_range_provider,node_node_resolver,node_epoch_resolver,node_middleware toneMint
class node_caller toneIndigo
```

## Components

### Public API

- [Generator contract](https://github.com/fangfengxiang/revid-engine/blob/main/revid.go): `revid.go`
- **Numeric ID**
- **Encoded ID**

### Generation Strategies

- [Segmented generator](https://github.com/fangfengxiang/revid-engine/blob/main/segmented.go): `segmented.go`
- [Snowflake generator](https://github.com/fangfengxiang/revid-engine/blob/main/snowflake.go): `snowflake.go`

### Providers & Middleware

- [Range provider](https://github.com/fangfengxiang/revid-engine/blob/main/revid.go): `revid.go`
- [Node resolver](https://github.com/fangfengxiang/revid-engine/blob/main/revid.go): `revid.go`
- [Epoch resolver](https://github.com/fangfengxiang/revid-engine/blob/main/snowflake.go): `snowflake.go`
- [Middleware options](https://github.com/fangfengxiang/revid-engine/blob/main/revid.go): `revid.go`

### Other components

- **Library caller**

## Connections

- Library caller → Generator contract: uses (evidence: `README.md`)
- Generator contract → Segmented generator: constructs via (evidence: `segmented.go`)
- Generator contract → Snowflake generator: constructs via (evidence: `snowflake.go`)
- Segmented generator → Range provider: fetches ranges (evidence: `segmented.go`)
- Snowflake generator → Node resolver: resolves node (evidence: `snowflake.go`)
- Snowflake generator → Epoch resolver: resolves epoch (evidence: `snowflake.go`)
- Segmented generator → Middleware options: runs hooks (evidence: `segmented.go`)
- Snowflake generator → Middleware options: runs hooks (evidence: `snowflake.go`)
- Segmented generator → Numeric ID: returns numeric ID (evidence: `segmented.go`)
- Snowflake generator → Numeric ID: returns numeric ID (evidence: `snowflake.go`)
- Segmented generator → Encoded ID: encodes ID (evidence: `segmented.go`)
- Snowflake generator → Encoded ID: encodes ID (evidence: `snowflake.go`)
