[GH-ISSUE #132] [Client] Add examples of use to documentation #362

New issue

Closed

opened 2026-03-15 22:09:19 +03:00 by kerem · 3 comments

kerem commented

2026-03-15 22:09:19 +03:00

Owner

Originally created by @SamWhited on GitHub (May 12, 2017).
Original GitHub issue: https://github.com/hickory-dns/hickory-dns/issues/132

It is unclear to me from looking at the documentation what the difference between, say, a Client and a ClientHandler is, or how you'd perform basic operations (eg. querying DNS srv records, or what type is useful if you want to have a function just take "a client").

Having usage examples in the documentation for each type and in the module documentation for client would make getting started with this library much easier. Similar examples should be added for other modules too.

Originally created by @SamWhited on GitHub (May 12, 2017). Original GitHub issue: https://github.com/hickory-dns/hickory-dns/issues/132 It is unclear to me from looking at the documentation what the difference between, say, a `Client` and a `ClientHandler` is, or how you'd perform basic operations (eg. querying DNS srv records, or what type is useful if you want to have a function just take "a client"). Having usage examples in the documentation for each type and in the module documentation for client would make getting started with this library much easier. Similar examples should be added for other modules too.

kerem

2026-03-15 22:09:19 +03:00

closed this issue
added the
docs
label

kerem commented

2026-03-15 22:09:35 +03:00

Author

Owner

@bluejekyll commented on GitHub (May 12, 2017):

Yes. I keep planning to do this. I will add some when I have some time, but will also gladly accept PRs.

For now please look at tests: https://github.com/bluejekyll/trust-dns/blob/master/server/tests/client_tests.rs

@bluejekyll commented on GitHub (May 12, 2017): Yes. I keep planning to do this. I will add some when I have some time, but will also gladly accept PRs. For now please look at tests: https://github.com/bluejekyll/trust-dns/blob/master/server/tests/client_tests.rs

kerem commented

2026-03-15 22:09:40 +03:00

Author

Owner

@bluejekyll commented on GitHub (Jun 30, 2017):

From reddit: "I need to send a dns request to check A, AAAA, MX and SOA records of a domain."

https://www.reddit.com/r/rust/comments/6kgjnq/retrieving_and_parsing_different_types_of_dns/

@bluejekyll commented on GitHub (Jun 30, 2017): From reddit: "I need to send a dns request to check A, AAAA, MX and SOA records of a domain." https://www.reddit.com/r/rust/comments/6kgjnq/retrieving_and_parsing_different_types_of_dns/

kerem commented

2026-03-15 22:09:45 +03:00

Author

Owner

@bluejekyll commented on GitHub (Jul 7, 2017):

FYI, please see https://docs.rs/trust-dns and https://docs.rs/trust-dns-resolver for example docs on the libraries.

@bluejekyll commented on GitHub (Jul 7, 2017): FYI, please see https://docs.rs/trust-dns and https://docs.rs/trust-dns-resolver for example docs on the libraries.

kerem referenced this issue

2026-03-16 02:03:46 +03:00

[PR #362] [CLOSED] Fix compile error in TimeoutStream #1387