# `postgres_rustls`
[<img alt="git" src="https://git.philomathiclife.com/badges/postgres_rustls.svg" height="20">](https://git.philomathiclife.com/postgres_rustls/log.html)
[<img alt="crates.io" src="https://img.shields.io/crates/v/postgres_rustls.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/postgres_rustls)
[<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-postgres_rustls-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs" height="20">](https://docs.rs/postgres_rustls/latest/postgres_rustls/)
`postgres_rustls` is a library that adds TLS support to [`tokio-postgres`](https://crates.io/crates/tokio-postgres)
using [`tokio-rustls`](https://crates.io/crates/tokio-rustls).
## Minimum Supported Rust Version (MSRV)
This will frequently be updated to be the same as stable. Specifically, any time stable is updated and that
update has "useful" features or compilation no longer succeeds (e.g., due to new compiler lints), then MSRV
will be updated.
MSRV changes will correspond to a SemVer patch version bump pre-`1.0.0`; otherwise a minor version bump.
## SemVer Policy
* All on-by-default features of this library are covered by SemVer
* MSRV is considered exempt from SemVer as noted above
## License
Licensed under either of
* Apache License, Version 2.0 ([LICENSE-APACHE](https://www.apache.org/licenses/LICENSE-2.0))
* MIT license ([LICENSE-MIT](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.
Before any PR is sent, `cargo clippy` and `cargo t` should be run _for each possible combination of "features"_
using stable Rust. One easy way to achieve this is by building `ci` and invoking it with no commands in the
`postgres_rustls` directory or sub-directories. You can fetch `ci` via `git clone https://git.philomathiclife.com/repos/ci`,
and it can be built with `cargo build --release`. Additionally,
`RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features` should be run to ensure documentation can be built.
Note that when running `cargo t` you will need to make sure PostgreSQL is set up properly. You will likely need
to modify some of the test data like username to run the tests.
### Status
This package is actively maintained and will conform to the
[latest version of `tokio-postgres`](https://crates.io/crates/tokio-postgres).
The crate is only tested on `x86_64-unknown-linux-gnu` and `x86_64-unknown-openbsd` targets, but it should work
on most platforms.