xtax 0.1.2

xTax Rust infrastructure ecosystem — a Cargo workspace of independent, composable crates.
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

# xTax

[![CI](https://github.com/cz-jcode/xtax/actions/workflows/ci.yml/badge.svg)](https://github.com/cz-jcode/xtax/actions/workflows/ci.yml)
[![CodeQL](https://github.com/cz-jcode/xtax/actions/workflows/codeql.yml/badge.svg)](https://github.com/cz-jcode/xtax/actions/workflows/codeql.yml)
[![Dependabot](https://img.shields.io/badge/dependabot-active-blue?logo=dependabot)](https://github.com/cz-jcode/xtax/network/updates)
[![crates.io](https://img.shields.io/crates/v/xtax.svg)](https://crates.io/crates/xtax)
[![docs.rs](https://docs.rs/xtax/badge.svg)](https://docs.rs/xtax)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/5f6106e413274dfcac3179c96ed643bf)](https://app.codacy.com/gh/cz-jcode/xtax/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)

Rust infrastructure ecosystem — a Cargo workspace of independent, composable crates.

## What is xTax?

`xtax` is **not** a monolithic framework. It's a **workspace** / semi-monorepo that
hosts a growing collection of standalone Rust crates for building backend infrastructure.

The top-level `xtax` crate is a thin **facade** — it contains **no logic** of its own.
It only re-exports selected subcrates behind Cargo feature flags, giving you a single
dependency with composable, opt-in functionality.

## Crates

| Crate | Description | Status |
|-------|-------------|---|
| [`xtax-blob-storage`](crates/xtax-blob-storage/) | Application-level blob storage abstraction with filesystem/S3 backends, optional encryption, rekey, cleanup, and background maintenance. | [![crates.io](https://img.shields.io/crates/v/xtax-blob-storage.svg)](https://crates.io/crates/xtax-blob-storage) |
| [`xtax-encryption`](crates/xtax-encryption/) | Trait-only encryption provider interface. | [![crates.io](https://img.shields.io/crates/v/xtax-encryption.svg)](https://crates.io/crates/xtax-encryption) |

Future planned crates (not yet created):
- `xtax-state-store` — generic state persistence layer
- `xtax-state-query` — query layer on top of state store

## Usage — via the facade

Add `xtax` with feature flags:

```toml
[dependencies]
xtax = { version = "0.1", features = ["blob-storage"] }
```

```rust
use xtax::blob_storage::BlobStoreBuilder;
```

## Usage — direct dependency

You can also depend directly on any subcrate:

```toml
[dependencies]
xtax-blob-storage = "0.1"
```

```rust
use xtax_blob_storage::BlobStoreBuilder;
```

Both paths are valid and supported.

## Architecture rules

- The `xtax` facade crate contains **no logic** — only re-exports.
- Each subcrate has **standalone value** and can be used independently.
- Subcrates **must not** depend on the facade crate.
- Dependency direction: `xtax` → subcrate, never the reverse.
- Private/internal application glue (runtime bootstrap, telemetry, S3/OpenObserve
  setup, encryption config) must **not** be moved into public crates.
- Runtime/bootstrap crates remain private unless intentionally generalized.
- Application config crates remain private unless intentionally generalized.
- Public crates must not know about concrete deployment infrastructure unless
  that is their explicit domain.

## Feature flags (facade)
| Feature             | Description |
|---------------------|-------------|
| `encryption`        | Re-exports `xtax-encryption` |
| `blob-storage`      | Enables filesystem backend via `xtax-blob-storage` |
| `blob-storage-s3`   | Enables S3 backend via `xtax-blob-storage` |
| `blob-storage-full` | Enables all blob-storage backends exposed by the facade |
| `full`              | Enables all currently exposed facade features, including `encryption` |

Default features: **none**. You opt in to exactly what you need.

## Documentation

| Crate | docs.rs | Guides |
|-------|---------|--------|
| `xtax` (facade) | [docs.rs](https://docs.rs/xtax) | — |
| `xtax-blob-storage` | [docs.rs](https://docs.rs/xtax-blob-storage) | [Guide](crates/xtax-blob-storage/docs/guide.md) · [Architecture](crates/xtax-blob-storage/docs/architecture.md) · [Backends](crates/xtax-blob-storage/docs/backends.md) · [Encryption](crates/xtax-blob-storage/docs/encryption.md) · [All docs](crates/xtax-blob-storage/docs/) |
| `xtax-encryption` | [docs.rs](https://docs.rs/xtax-encryption) | [README](crates/xtax-encryption/README.md) |

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for release/publishing instructions and contribution guidelines.

## License

Licensed under either of:

- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE))
- MIT license ([LICENSE-MIT](LICENSE-MIT))

at your option.