Mention redox' behavior in doc comments

This commit is contained in:
jD91mZM2
2018-06-26 08:23:16 +02:00
parent 4bebd24fca
commit c86a7a01e2
2 changed files with 12 additions and 0 deletions

View File

@@ -197,6 +197,9 @@ impl UnixStream {
/// println!("Got error: {:?}", err); /// println!("Got error: {:?}", err);
/// } /// }
/// ``` /// ```
///
/// # Platform specific
/// On Redox this always returns None.
pub fn take_error(&self) -> io::Result<Option<io::Error>> { pub fn take_error(&self) -> io::Result<Option<io::Error>> {
Ok(None) Ok(None)
} }
@@ -400,6 +403,9 @@ impl UnixListener {
/// println!("Got error: {:?}", err); /// println!("Got error: {:?}", err);
/// } /// }
/// ``` /// ```
///
/// # Platform specific
/// On Redox this always returns None.
pub fn take_error(&self) -> io::Result<Option<io::Error>> { pub fn take_error(&self) -> io::Result<Option<io::Error>> {
Ok(None) Ok(None)
} }

View File

@@ -524,6 +524,9 @@ impl UnixStream {
/// println!("Got error: {:?}", err); /// println!("Got error: {:?}", err);
/// } /// }
/// ``` /// ```
///
/// # Platform specific
/// On Redox this always returns None.
#[stable(feature = "unix_socket", since = "1.10.0")] #[stable(feature = "unix_socket", since = "1.10.0")]
pub fn take_error(&self) -> io::Result<Option<io::Error>> { pub fn take_error(&self) -> io::Result<Option<io::Error>> {
self.0.take_error() self.0.take_error()
@@ -846,6 +849,9 @@ impl UnixListener {
/// println!("Got error: {:?}", err); /// println!("Got error: {:?}", err);
/// } /// }
/// ``` /// ```
///
/// # Platform specific
/// On Redox this always returns None.
#[stable(feature = "unix_socket", since = "1.10.0")] #[stable(feature = "unix_socket", since = "1.10.0")]
pub fn take_error(&self) -> io::Result<Option<io::Error>> { pub fn take_error(&self) -> io::Result<Option<io::Error>> {
self.0.take_error() self.0.take_error()