Sync documentation for hyper_util::server::conn::auto::Http1Builder::header_read_timeout with hyper's hyper::server::conn::http1::Builder::header_read_timeout.

[aaronriekenberg]

I think the default of 30 seconds, and the commentary about needing to set Timer to avoid panics are true for hyper_util::server::conn::auto::Builder? I copied documentation from Hyper here: https://github.com/hyperium/hyper/blob/master/src/server/conn/http1.rs#L311-L323

A possibly larger question - should auto::Builder do something to setup a Timer by default for http1/http2 builders? Already auto::Builder::new takes an executor parameter, should this also take a timer parameter?

Thanks! 😃

[seanmonstar]

Thanks for improving the docs! I really appreciate it <3

[seanmonstar]

A possibly larger question - should auto::Builder do something to setup a Timer by default for http1/http2 builders? Already auto::Builder::new takes an executor parameter, should this also take a timer parameter?

Hm, I suppose it could be explored and if it feels better, introduced as a breaking change in hyper-util 0.2 or something. One additional option is making use of typestate (such as what rustls does, such that if you want to set timeout options, you have to have set a timer, but it's therefore not required if you don't need timeouts.

impl<E> Builder<E, NeedsTimer> {
    pub fn timer<T>(self, timer: T) -> Builder<E, HasTimer> {
        // ...
    }
}

impl<E> Builder<E, HasTimer> {
    pub fn http1_read_timeout(self, timeout: Duration) -> Self {
        // ...
    }
}

No promises that we'd do that, but if that doesn't phase you, you're welcome to explore separately and see how it goes :)

[aaronriekenberg]

Addressed review comments.

Will take a look at using typestate separately.

Thank you!