camel-endpoint 0.5.0

Endpoint abstractions for rust-camel
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

# camel-endpoint

> Endpoint parsing and URI handling for rust-camel

## Overview

`camel-endpoint` provides URI parsing and endpoint abstraction for the rust-camel framework. It handles the parsing of endpoint URIs in the format `scheme:path?param1=value1&param2=value2` that Camel is known for.

This crate is used internally by components to parse their configuration from URI strings.

## Features

- URI parsing with scheme, path, and query parameters
- `UriComponents` struct for easy access to URI parts
- `UriConfig` derive macro for declarative, typed component configuration
- Error handling for malformed URIs

## Installation

Add to your `Cargo.toml`:

```toml
[dependencies]
camel-endpoint = "0.2"
```

## Usage

```rust
use camel_endpoint::{parse_uri, UriComponents};

// Parse a Camel-style URI
let uri = "timer:tick?period=1000&delay=500";
let components = parse_uri(uri).unwrap();

assert_eq!(components.scheme, "timer");
assert_eq!(components.path, "tick");
assert_eq!(components.params.get("period"), Some(&"1000".to_string()));
assert_eq!(components.params.get("delay"), Some(&"500".to_string()));
```

## Declarative Config with `UriConfig`

The `#[derive(UriConfig)]` macro generates typed config structs from URI query parameters:

```rust
use camel_endpoint::UriConfig;

#[derive(UriConfig)]
pub struct TimerConfig {
    pub period: u64,         // ?period=1000
    #[uri(default = "0")]
    pub delay: u64,          // ?delay=500  (optional, default 0)
    #[uri(rename = "repeatCount")]
    pub repeat_count: Option<u64>,
}

// Parse directly from a URI
let config = TimerConfig::from_uri("timer:tick?period=1000&delay=200").unwrap();
assert_eq!(config.period, 1000);
assert_eq!(config.delay, 200);
```

## URI Format

Endpoints follow the standard Camel URI format:

```
scheme:path[?param1=value1&param2=value2]
```

- `scheme`: The component name (e.g., `timer`, `file`, `http`)
- `path`: Component-specific path (e.g., timer name, file directory)
- `params`: Optional query parameters for configuration

## Documentation

- [API Documentation](https://docs.rs/camel-endpoint)
- [Repository](https://github.com/kennycallado/rust-camel)

## License

Apache-2.0

## Contributing

Contributions are welcome! Please see the [main repository](https://github.com/kennycallado/rust-camel) for details.