postgres_rustls

Rustls-based library for postgres.
git clone https://git.philomathiclife.com/repos/postgres_rustls
Log | Files | Refs | README

README.md (2624B)

      1 # `postgres_rustls`
      2 
      3 [<img alt="git" src="https://git.philomathiclife.com/badges/postgres_rustls.svg" height="20">](https://git.philomathiclife.com/postgres_rustls/log.html)
      4 [<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)
      5 [<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/)
      6 
      7 `postgres_rustls` is a library that adds TLS support to [`tokio-postgres`](https://crates.io/crates/tokio-postgres)
      8 using [`tokio-rustls`](https://crates.io/crates/tokio-rustls).
      9 
     10 ## Minimum Supported Rust Version (MSRV)
     11 
     12 This will frequently be updated to be the same as stable. Specifically, any time stable is updated and that
     13 update has "useful" features or compilation no longer succeeds (e.g., due to new compiler lints), then MSRV
     14 will be updated.
     15 
     16 MSRV changes will correspond to a SemVer patch version bump pre-`1.0.0`; otherwise a minor version bump.
     17 
     18 ## SemVer Policy
     19 
     20 * All on-by-default features of this library are covered by SemVer
     21 * MSRV is considered exempt from SemVer as noted above
     22 
     23 ## License
     24 
     25 Licensed under either of
     26 
     27 * Apache License, Version 2.0 ([LICENSE-APACHE](https://www.apache.org/licenses/LICENSE-2.0))
     28 * MIT license ([LICENSE-MIT](https://opensource.org/licenses/MIT))
     29 
     30 at your option.
     31 
     32 ## Contribution
     33 
     34 Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you,
     35 as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
     36 
     37 Before any PR is sent, `cargo clippy` and `cargo t` should be run for both `--no-default-features` and
     38 `--all-features`. Additionally `RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features` should be run to
     39 ensure documentation can be built.
     40 
     41 Note when running `cargo t` for the `ignored` tests, you will need to make sure PostgreSQL is set up properly. You
     42 will need to modify some of the files in `test_data/`. See
     43 [`test_data/README.md`](https://git.philomathiclife.com/postgres_rustls/file/test_data/README.md.html) for more
     44 information.
     45 
     46 ### Status
     47 
     48 This package is actively maintained and will conform to the latest versions of
     49 [`tokio-postgres`](https://crates.io/crates/tokio-postgres) and
     50 [`tokio-rustls`](https://crates.io/crates/tokio-rustls).
     51 
     52 The crate is only tested on `x86_64-unknown-linux-gnu` and `x86_64-unknown-openbsd` targets, but it should work
     53 on most platforms.