Skip to content

Commit 72dbefd

Browse files
committed
Update links and names in README and docuemntation to point to hickory-dns (trust-dns new name)
1 parent 5e884f0 commit 72dbefd

File tree

3 files changed

+13
-10
lines changed

3 files changed

+13
-10
lines changed

Cargo.toml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ name = "hyper-trust-dns-connector"
33
version = "0.5.0"
44
authors = ["Paul Le Grand Des Cloizeaux <@paullgdc>"]
55
edition = "2018"
6-
description = "A compatibility crate to use trust-dns-resolver asynchronously with hyper client, instead the default dns threadpool"
6+
description = "A compatibility crate to use hickory-dns asynchronously with hyper client, instead the default dns threadpool"
77
repository = "https://github.com/paullgdc/hyper-trust-dns-connector"
88
readme = "README.md"
99
license = "MIT"
10-
keywords = ["resolver", "hyper", "trust-dns", "webclient", "async"]
10+
keywords = ["resolver", "hyper", "trust-dns", "hickory-dns", "webclient", "async"]
1111
categories = ["asynchronous", "web-programming::http-client", "network-programming"]
1212

1313
[package.metadata.docs.rs]
@@ -19,6 +19,9 @@ hickory-resolver = "0.24"
1919
hyper = { version = "0.14", features = ["tcp", "client"] }
2020
hyper-tls = { version = "0.5", optional = true }
2121
native-tls = { version = "0.2", optional = true }
22+
# We depend on this crate indirectly.
23+
# This is pinned to >=0.5.3 because it contains UBs for lower versions
24+
# See https://github.com/contain-rs/lru-cache/issues/50
2225
linked-hash-map = "0.5.3"
2326

2427
[dev-dependencies]

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![crates.io](https://meritbadge.herokuapp.com/hyper-trust-dns-connector)](https://crates.io/crates/hyper-trust-dns-connector)
55
[![Released API docs](https://docs.rs/hyper-trust-dns-connector/badge.svg)](https://docs.rs/hyper-trust-dns-connector)
66

7-
A crate to make [trust-dns-resolver](https://docs.rs/trust-dns-resolver)'s
7+
A crate to make [hickory-resolver](https://docs.rs/hickory-resolver/)'s (previously trust_dns_resolver)
88
asynchronous resolver compatible with [hyper](https://docs.rs/hyper) client,
99
to use instead of the default dns threadpool.
1010

@@ -13,7 +13,7 @@ to use instead of the default dns threadpool.
1313
## Motivations
1414

1515
By default hyper HttpConnector uses the std provided resolver wich is blocking in a threadpool
16-
with a configurable number of threads. This crate provides an alternative using trust_dns_resolver,
16+
with a configurable number of threads. This crate provides an alternative using hickory-resolver,
1717
a dns resolver written in Rust, with async features.
1818

1919
## Example

src/lib.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#![cfg_attr(docsrs, feature(doc_cfg))]
22
//! # hyper_trust_dns_connector
33
//!
4-
//! A crate to make [trust-dns-resolver](https://docs.rs/trust-dns-resolver)'s
4+
//! A crate to make [hickory-resolver](https://docs.rs/hickory-resolver/)'s (previously trust_dns_resolver)
55
//! asynchronous resolver compatible with [hyper](https://docs.rs/hyper) client,
66
//! to use instead of the default dns threadpool.
77
//!
@@ -14,7 +14,7 @@
1414
//!
1515
//! ## Usage
1616
//!
17-
//! [trust-dns-resolver](https://docs.rs/trust-dns-resolver) creates an async resolver
17+
//! [hickory-resolver](https://docs.rs/hickory-resolver/) creates an async resolver
1818
//! for dns queries, which is then used by hyper
1919
//!
2020
//! ## Example
@@ -44,8 +44,8 @@ use std::pin::Pin;
4444
use std::task::{Context, Poll};
4545
use std::{future::Future, net::SocketAddr, net::ToSocketAddrs};
4646

47-
/// Wrapper around trust-dns-resolver's
48-
/// [`TokioAsyncResolver`](https://docs.rs/trust-dns-resolver/0.20.0/trust_dns_resolver/type.TokioAsyncResolver.html)
47+
/// Wrapper around hickory-resolver's
48+
/// [`TokioAsyncResolver`](https://docs.rs/hickory-resolver/0.24.2/hickory_resolver/type.TokioAsyncResolver.html)
4949
///
5050
/// The resolver runs a background Task which manages dns requests. When a new resolver is created,
5151
/// the background task is also created, it needs to be spawned on top of an executor before using the client,
@@ -55,14 +55,14 @@ pub struct AsyncHyperResolver(TokioAsyncResolver);
5555

5656
impl AsyncHyperResolver {
5757
/// constructs a new resolver, arguments are passed to the corresponding method of
58-
/// [`TokioAsyncResolver`](https://docs.rs/trust-dns-resolver/0.20.0/trust_dns_resolver/type.TokioAsyncResolver.html#method.new)
58+
/// [`TokioAsyncResolver`](https://docs.rs/hickory-resolver/0.24.2/hickory_resolver/struct.AsyncResolver.html#method.new)
5959
pub fn new(config: ResolverConfig, options: ResolverOpts) -> Result<Self, io::Error> {
6060
let resolver = TokioAsyncResolver::tokio(config, options);
6161
Ok(Self(resolver))
6262
}
6363

6464
/// constructs a new resolver from default configuration, uses the corresponding method of
65-
/// [`TokioAsyncResolver`](https://docs.rs/trust-dns-resolver/0.20.0/trust_dns_resolver/type.TokioAsyncResolver.html#method.new)
65+
/// [`TokioAsyncResolver`](https://docs.rs/hickory-resolver/0.24.2/hickory_resolver/struct.AsyncResolver.html#method.tokio_from_system_conf)
6666
pub fn new_from_system_conf() -> Result<Self, io::Error> {
6767
let resolver = TokioAsyncResolver::tokio_from_system_conf()?;
6868
Ok(Self(resolver))

0 commit comments

Comments
 (0)