watermelon-mini 0.1.0

Minimal NATS Core client implementation
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

<h1 align="center">watermelon</h1>
<div align="center">
    <small>
        Pure Rust NATS client implementation and tokio integration
    </small>
</div>

`watermelon` is an independent implementation of the NATS protocol.
The goal of the project is to produce an opinionated, composable,
idiomatic implementation with a keen eye on security, correctness and
ease of use.

Watermelon is divided into multiple crates, all hosted in the same monorepo.

| Crate name         | Crates.io release                                                                                               | Documentation                                                                                    | Description                                                                              |
| ------------------ | --------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------- |
| `watermelon`       | [![crates.io](https://img.shields.io/crates/v/watermelon.svg)](https://crates.io/crates/watermelon)             | [![Documentation](https://docs.rs/watermelon/badge.svg)](https://docs.rs/watermelon)             | High level actor based implementation NATS Core and NATS Jetstream client implementation |
| `watermelon-mini`  | [![crates.io](https://img.shields.io/crates/v/watermelon-mini.svg)](https://crates.io/crates/watermelon-mini)   | [![Documentation](https://docs.rs/watermelon-mini/badge.svg)](https://docs.rs/watermelon-mini)   | Minimal NATS Core client implementation                                                  |
| `watermelon-net`   | [![crates.io](https://img.shields.io/crates/v/watermelon-net.svg)](https://crates.io/crates/watermelon-net)     | [![Documentation](https://docs.rs/watermelon-net/badge.svg)](https://docs.rs/watermelon-net)     | Low-level NATS Core network implementation                                               |
| `watermelon-proto` | [![crates.io](https://img.shields.io/crates/v/watermelon-proto.svg)](https://crates.io/crates/watermelon-proto) | [![Documentation](https://docs.rs/watermelon-proto/badge.svg)](https://docs.rs/watermelon-proto) | `#[no_std]` NATS Core Sans-IO protocol implementation                                    |
| `watermelon-proto` | [![crates.io](https://img.shields.io/crates/v/watermelon-proto.svg)](https://crates.io/crates/watermelon-nkeys) | [![Documentation](https://docs.rs/watermelon-nkeys/badge.svg)](https://docs.rs/watermelon-nkeys) | Minimal NKeys implementation for NATS client authentication                              |

# Advantages over `async-nats`

1. **Security**: this client is protected against command injection attacks via checked APIs like `Subject`.
2. **Extendibility**: exposes the inner components via `watermelon-mini` and `watermelon-net`.
3. **Error handling**: `subscribe` errors are correctly caught - internally enables server verbose mode.
4. **Fresh start**: this client only supports nats-server >=2.10.0. We may drop support for older server versions as new ones come out. `tls://` also uses _TLS-first handshake_ mode by default.
5. **Licensing**: dual licensed under MIT and APACHE-2.0.

# Disadvantages over `async-nats`

1. **Completeness**: most APIs (Jetstream specifically) haven't been implemented yet.
2. **Future work**: we may never add support for functionallity that we, M4SS Srl, don't use.
3. **Difference in APIs**: official NATS clients tend to have similar APIs. `watermelon` does not follow the official guidelines.
4. **Ecosystem**: as the client does not support older server versions or ignore old configuration options, it may not work in an environment that hasn't adopted the new standards yet.
5. **Backwards compatibility**: this client is in no way compatible with the `async-nats` API and may make frequent breaking changes.

## License

Licensed under either of

- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or <https://www.apache.org/licenses/LICENSE-2.0>)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or <https://opensource.org/licenses/MIT>)

at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.