docs(server): deprecated bind_connection, note about Connection's Opaque item

This commit is contained in:
Sean McArthur
2018-01-30 13:18:51 -08:00
parent 44af273853
commit 2a74b91181
2 changed files with 13 additions and 10 deletions

View File

@@ -105,6 +105,16 @@ pub struct AddrIncoming {
/// A future binding a connection with a Service.
///
/// Polling this future will drive HTTP forward.
///
/// # Note
///
/// This will currently yield an unnameable (`Opaque`) value
/// on success. The purpose of this is that nothing can be assumed about
/// the type, not even it's name. It's probable that in a later release,
/// this future yields the underlying IO object, which could be done without
/// a breaking change.
///
/// It is likely best to just map the value to `()`, for now.
#[must_use = "futures do nothing unless polled"]
pub struct Connection<I, S>
where