[GH-ISSUE #1932] Small doc issues #821

New issue

Open

opened 2026-03-16 00:25:59 +03:00 by kerem · 2 comments

kerem commented

2026-03-16 00:25:59 +03:00

Owner

Originally created by @andrewbaxter on GitHub (May 15, 2023).
Original GitHub issue: https://github.com/hickory-dns/hickory-dns/issues/1932

UdpClientStream says it returns a tuple, but it really only returns one value.

/// it is expected that the resolver wrapper will be responsible for creating and managing
///  new UdpClients such that each new client would have a random port (reduce chance of cache
///  poisoning)
///
/// # Return
///
/// a tuple of a Future Stream which will handle sending and receiving messages, and a
///  handle which can be used to send messages into the stream.

Also, as an aside, I had trouble finding out you use AsyncClient::connect(stream) for udp instead of AsyncClient::new(...) - the examples seem to be all TCP. Maybe TCP is the way to go though.

ResponseHandle::send_response says it consumes itself, but really takes &mut self

/// Serializes and sends a message to to the wrapped handle
///
/// self is consumed as only one message should ever be sent in response to a Request

The above comment makes sense with the signature for RequestHandler:

     async fn handle_request<R: ResponseHandler>(
        &self,
        request: &Request,
        response_handle: R,
    ) -> ResponseInfo;

but since it takes a mut ref, I'd expect response_handle: R.

This is a super cool library, thanks for all the work that went into this!

Originally created by @andrewbaxter on GitHub (May 15, 2023). Original GitHub issue: https://github.com/hickory-dns/hickory-dns/issues/1932 1. `UdpClientStream` says it returns a tuple, but it really only returns one value. ``` /// it is expected that the resolver wrapper will be responsible for creating and managing /// new UdpClients such that each new client would have a random port (reduce chance of cache /// poisoning) /// /// # Return /// /// a tuple of a Future Stream which will handle sending and receiving messages, and a /// handle which can be used to send messages into the stream. ``` Also, as an aside, I had trouble finding out you use `AsyncClient::connect(stream)` for udp instead of `AsyncClient::new(...)` - the examples seem to be all TCP. Maybe TCP is the way to go though. 2. `ResponseHandle::send_response` says it consumes itself, but really takes `&mut self` ``` /// Serializes and sends a message to to the wrapped handle /// /// self is consumed as only one message should ever be sent in response to a Request ``` The above comment makes sense with the signature for `RequestHandler`: ``` async fn handle_request<R: ResponseHandler>( &self, request: &Request, response_handle: R, ) -> ResponseInfo; ``` but since it takes a mut ref, I'd expect `response_handle: R`. This is a super cool library, thanks for all the work that went into this!

kerem added the

docs

label

2026-03-16 00:25:59 +03:00

kerem commented

2026-03-16 00:26:19 +03:00

Author

Owner

@djc commented on GitHub (May 15, 2023):

Would be happy to review a PR with your suggested changes!

@djc commented on GitHub (May 15, 2023): Would be happy to review a PR with your suggested changes!

kerem commented

2026-03-16 00:26:24 +03:00

Author

Owner

@andrewbaxter commented on GitHub (May 15, 2023):

Sorry, my hands are full with other things atm! I thought leaving the info here might be useful, since it's easy to lose track of things like this.

@andrewbaxter commented on GitHub (May 15, 2023): Sorry, my hands are full with other things atm! I thought leaving the info here might be useful, since it's easy to lose track of things like this.