pimalaya-stream 0.1.2

Stream, TLS and SASL utils for Pimalaya
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

# Contributing guide

Thank you for investing your time in contributing to pimalaya-stream.

Whether you are a human or an AI agent, read these in order before touching the code:

1. the [Pimalaya README](https://github.com/pimalaya) for what the project is and how its repositories stack;
2. the [Pimalaya CONTRIBUTING](https://github.com/pimalaya/.github/blob/master/CONTRIBUTING.md) guide, which chains to the shared architecture and guidelines;
3. the inline header documentation, starting with src/lib.rs: it is the architecture document of this crate;
4. this guide, for what differs from the Pimalaya standards.

Everything below documents only the differences.

## Deliberately std

pimalaya-stream wraps TLS providers and sockets and exposes no I/O-free coroutines, so the no_std layer checks of the org guide do not apply: there is no coroutine core to keep std-free. The layers to build against are the feature-gated transport and TLS providers:

```sh
cargo build --no-default-features                          # sasl + tls configs only
cargo build --no-default-features --features std           # + blocking transport, no TLS
cargo build                                                # rustls-ring (default)
cargo build --no-default-features --features rustls-aws
cargo build --no-default-features --features native-tls
```