What is the problem your feature solves, or the need it fulfills?
The PeerOptions struct defers documentation to the Peer trait. The fields of the struct do not match that of the methods of the trait 1:1
Most notably, I am finding that the lack of documentation on idle timeouts to be a bit confusing. I have set the idle_timeout to 5 seconds nothing happens after making a connection. No timeout occurs.
If I set read_timeout to 5 seconds, after 5 seconds there is a timeout as anticipated.
Request: document PeerOptions fields. Notably, document the fields that do not have a corresponding value in the Peer trait.
Fields with no corresponding documentation in trait methods:
What is the problem your feature solves, or the need it fulfills?
The PeerOptions struct defers documentation to the Peer trait. The fields of the struct do not match that of the methods of the trait 1:1
Most notably, I am finding that the lack of documentation on idle timeouts to be a bit confusing. I have set the
idle_timeoutto 5 seconds nothing happens after making a connection. No timeout occurs.If I set
read_timeoutto 5 seconds, after 5 seconds there is a timeout as anticipated.Request: document
PeerOptionsfields. Notably, document the fields that do not have a corresponding value in the Peer trait.Fields with no corresponding documentation in trait methods: