docs(server): add a warning to Listening::close() in order to reflect #338

This commit is contained in:
Johan Lorenzo
2016-02-19 14:24:38 +01:00
parent a2ab168186
commit 5c8b63028c

View File

@@ -407,6 +407,9 @@ impl Drop for Listening {
}
impl Listening {
/// Warning: This function doesn't work. The server remains listening after you called
/// it. See https://github.com/hyperium/hyper/issues/338 for more details.
///
/// Stop the server from listening to its socket address.
pub fn close(&mut self) -> ::Result<()> {
let _ = self._guard.take();