rs-mongo-stream 0.1.0

Wrapper on mongo to easier the way to handle mongo stream
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

# rs-mongo-stream
A MongoDB change stream library for Rust applications

[![GitHub last commit](https://img.shields.io/github/last-commit/lsh0x/rs-mongo-stream)](https://github.com/lsh0x/rs-mongo-stream/commits/main)
[![CI](https://github.com/lsh0x/rs-mongo-stream/workflows/CI/badge.svg)](https://github.com/lsh0x/rs-mongo-stream/actions)
[![Codecov](https://codecov.io/gh/lsh0x/rs-mongo-stream/branch/main/graph/badge.svg)](https://codecov.io/gh/lsh0x/rs-mongo-stream)
[![Docs](https://docs.rs/rs-mongo-stream/badge.svg)](https://docs.rs/rs-mongo-stream)
[![Crates.io](https://img.shields.io/crates/v/rs-mongo-stream.svg)](https://crates.io/crates/rs-mongo-stream)
[![crates.io](https://img.shields.io/crates/d/rs-mongo-stream)](https://crates.io/crates/rs-mongo-stream)


## Overview

rs-mongo-stream is a Rust library that makes it easy to work with MongoDB change streams. It provides a simple interface to monitor and react to changes in your MongoDB collections by registering callbacks for different database events (insertions, updates, and deletions).

## Features

- **Event-based architecture**: Register callbacks for insert, update, and delete operations
- **Asynchronous support**: Built with Tokio for fully asynchronous operation
- **Automatic reconnection**: Handles stream disruptions gracefully
- **Implements Stream trait**: Can be used with standard Rust stream operations
- **Type-safe callbacks**: Strong typing for your event handlers

## Installation

Add the crate to your Cargo.toml:

```toml
[dependencies]
rs-mongo-stream = "0.1.0"
mongodb = "2.4.0"
tokio = { version = "1", features = ["full"] }
```

## Usage Example

```rust
use mongodb::{Client, options::ClientOptions};
use rs_mongo_stream::{MongoStream, Event};
use tokio;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Connect to MongoDB
    let client_options = ClientOptions::parse("mongodb://localhost:27017").await?;
    let client = Client::with_options(client_options)?;
    let db = client.database("my_database");
    
    // Create the stream monitor
    let mut stream = MongoStream::new(client.clone(), db);
    
    // Register callbacks for a collection
    stream.add_callback("users", Event::Insert("".to_string()), |event| {
        Box::pin(async move {
            println!("New user inserted: {:?}", event);
            // Handle the insertion...
        })
    });
    
    stream.add_callback("users", Event::Update("".to_string()), |event| {
        Box::pin(async move {
            println!("User updated: {:?}", event);
            // Handle the update...
        })
    });
    
    stream.add_callback("users", Event::Delete("".to_string()), |event| {
        Box::pin(async move {
            println!("User deleted: {:?}", event);
            // Handle the deletion...
        })
    });
    
    // Start monitoring the collection
    stream.start_stream("users").await?;
    
    Ok(())
}
```

## Error Handling

The library provides a custom `MongoStreamError` type that wraps errors from the MongoDB driver and adds context when needed.

## License

This project is licensed under the MIT License - see the LICENSE file for details.