titanium-rs 0.1.6

The ultimate high-performance Discord API framework for Rust
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

# Titanium-rs


[![License](https://img.shields.io/badge/license-AGPL--3.0-blue.svg)](LICENSE)
[![Rust](https://github.com/Sh4dowNotFound/titanium-rs/actions/workflows/rust.yml/badge.svg)](https://github.com/Sh4dowNotFound/titanium-rs/actions)
[![Documentation](https://img.shields.io/badge/docs-titanium-brightgreen)](https://sh4downotfound.github.io/titanium-rs/index.html)



**Titanium-rs** is a high-performance, concurrent Discord library for Rust, designed for massive scale.

## Documentation

Full documentation is available at: [https://sh4downotfound.github.io/titanium-rs/](https://sh4downotfound.github.io/titanium-rs/index.html)

## Features


- **Titanium Gateway**: A robust, zero-copy, highly concurrent WebSocket client for the Discord Gateway.
    - Zero-copy JSON parsing (via `simd-json` when enabled).
    - Zlib-stream compression support.
    - specialized `mimalloc` support for high throughput.
- **Titanium Voice**: A voice client with zero-allocation packet encryption.
- **Titanium Model**: Comprehensive, zero-copy friendly data models for Discord API entities.
- **Titanium Cache**: High-performance concurrent cache based on `DashMap`.

## Quick Start


### Installation


Add this to your `Cargo.toml`:

```toml
[dependencies]
titanium-rs = "0.1"
```

Then in your code:

```rust
use titanium_rs::prelude::*;
```

```

## Examples


Check out the `examples/` directory for full working bots:

- **[Basic Bot](https://github.com/Sh4dowNotFound/titanium-rs/blob/main/titanium/examples/basic_bot.rs)**: Simple ping-pong bot demonstrating event handling.
- **[Slash Commands](https://github.com/Sh4dowNotFound/titanium-rs/blob/main/titanium/examples/slash_commands.rs)**: Handling Application Commands (interactions).
- **[Voice Receive](https://github.com/Sh4dowNotFound/titanium-rs/blob/main/titanium/examples/voice_receive.rs)**: connecting to voice channels (skeleton).

To run an example:
```bash
cargo run --example basic_bot
```

## Optimization


To enable high-performance memory allocation:

```toml
[dependencies]
titanium-rs = { version = "0.1", features = ["performance"] }
```

## Safety


This project adheres to strict safety standards:
- `#![deny(unsafe_code)]` is enforced globally.
- Exceptions are essentially limited to SIMD optimizations and are strictly documented.

## License


AGPL-3.0-or-later