sync the various FromRawFd trait docs, and remove 'valid'
This commit is contained in:
@@ -27,17 +27,21 @@ pub trait FromRawFd {
|
||||
/// Constructs a new instance of `Self` from the given raw file
|
||||
/// descriptor.
|
||||
///
|
||||
/// This function **consumes [ownership][io-safety]** of the specified file
|
||||
/// descriptor. The returned object will take responsibility for closing
|
||||
/// it when the object goes out of scope.
|
||||
/// This function is typically used to **consume ownership** of the
|
||||
/// specified file descriptor. When used in this way, the returned object
|
||||
/// will take responsibility for closing it when the object goes out of
|
||||
/// scope.
|
||||
///
|
||||
/// [io-safety]: crate::io#io-safety
|
||||
/// However, consuming ownership is not strictly required. Use a
|
||||
/// [`From<OwnedFd>::from`] implementation for an API which strictly
|
||||
/// consumes ownership.
|
||||
///
|
||||
/// This function is also unsafe as the primitives currently returned
|
||||
/// have the contract that they are the sole owner of the file
|
||||
/// descriptor they are wrapping. Usage of this function could
|
||||
/// accidentally allow violating this contract which can cause memory
|
||||
/// unsafety in code that relies on it being true.
|
||||
/// # Safety
|
||||
///
|
||||
/// The `fd` passed in must be an [owned file descriptor][io-safety];
|
||||
/// in particular, it must be open.
|
||||
///
|
||||
/// [io-safety]: io#io-safety
|
||||
unsafe fn from_raw_fd(fd: RawFd) -> Self;
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user