Skip to content

Commit

Permalink
Overhaul crate API
Browse files Browse the repository at this point in the history
  • Loading branch information
sfackler committed Dec 24, 2020
1 parent ead9609 commit 56f6618
Show file tree
Hide file tree
Showing 4 changed files with 132 additions and 274 deletions.
7 changes: 5 additions & 2 deletions Cargo.toml
Expand Up @@ -12,10 +12,13 @@ An implementation of SSL streams for Tokio backed by OpenSSL
"""

[dependencies]
futures = "0.3"
openssl = "0.10.30"
openssl-sys = "0.9.58"
pin-project = "1.0"
tokio = "1.0"

[dev-dependencies]
futures = "0.3"
tokio = { version = "1.0", features = ["full"] }

[patch.crates-io]
openssl = { git = "https://github.com/sfackler/rust-openssl", branch = "always-unpin" }
28 changes: 1 addition & 27 deletions README.md
Expand Up @@ -2,38 +2,12 @@

An implementation of SSL streams for Tokio built on top of the [`openssl` crate]

[![Build Status](https://travis-ci.org/alexcrichton//tokio-openssl.svg?branch=master)](https://travis-ci.org/alexcrichton/tokio-openssl)
[![Build Status](https://travis-ci.org/alexcrichton//tokio-openssl.svg?branch=master)](https://travis-ci.org/sfackler/tokio-openssl)

[Documentation](https://docs.rs/tokio-openssl)

[`openssl` crate]: https://github.com/sfackler/rust-openssl

## Usage

First, add this to your `Cargo.toml`:

```toml
[dependencies]
openssl = "0.10"
tokio-openssl = "0.2"
```

Next, add this to your crate:

```rust
extern crate openssl;
extern crate tokio_openssl;

use tokio_openssl::{SslConnectorExt, SslAcceptorExt};
```

This crate provides two extension traits, `SslConnectorExt` and
`SslAcceptorExt`, which augment the functionality provided by the [`openssl`
crate]. These extension traits provide the ability to connect a stream
asynchronously and accept a socket asynchronously. Configuration of OpenSSL
parameters is still done through the support in the `openssl` crate.


# License

This project is licensed under either of
Expand Down

0 comments on commit 56f6618

Please sign in to comment.