Add documentation to more From::from
implementations.
For users looking at documentation through IDE popups, this gives them relevant information rather than the generic trait documentation wording “Performs the conversion”. For users reading the documentation for a specific type for any reason, this informs them when the conversion may allocate or copy significant memory versus when it is always a move or cheap copy. Notes on specific cases: * The new documentation for `From<T> for T` explains that it is not a conversion at all. * Also documented `impl<T, U> Into<U> for T where U: From<T>`, the other central blanket implementation of conversion. * I did not add documentation to conversions of a specific error type to a more general error type. * I did not add documentation to unstable code. This change was prepared by searching for the text "From<... for" and so may have missed some cases that for whatever reason did not match. I also looked for `Into` impls but did not find any worth documenting by the above criteria.
This commit is contained in:
parent
887999d163
commit
6fd5cf51c1
@ -2047,6 +2047,8 @@ fn index(&self, key: &Q) -> &V {
|
||||
|
||||
#[stable(feature = "std_collections_from_array", since = "1.56.0")]
|
||||
impl<K: Ord, V, const N: usize> From<[(K, V); N]> for BTreeMap<K, V> {
|
||||
/// Converts a `[(K, V); N]` into a `BTreeMap<(K, V)>`.
|
||||
///
|
||||
/// ```
|
||||
/// use std::collections::BTreeMap;
|
||||
///
|
||||
|
@ -1092,6 +1092,8 @@ fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> BTreeSet<T> {
|
||||
|
||||
#[stable(feature = "std_collections_from_array", since = "1.56.0")]
|
||||
impl<T: Ord, const N: usize> From<[T; N]> for BTreeSet<T> {
|
||||
/// Converts a `[T; N]` into a `BTreeSet<T>`.
|
||||
///
|
||||
/// ```
|
||||
/// use std::collections::BTreeSet;
|
||||
///
|
||||
|
@ -1953,6 +1953,8 @@ fn hash<H: Hasher>(&self, state: &mut H) {
|
||||
|
||||
#[stable(feature = "std_collections_from_array", since = "1.56.0")]
|
||||
impl<T, const N: usize> From<[T; N]> for LinkedList<T> {
|
||||
/// Converts a `[T; N]` into a `LinkedList<T>`.
|
||||
///
|
||||
/// ```
|
||||
/// use std::collections::LinkedList;
|
||||
///
|
||||
|
@ -3018,6 +3018,8 @@ fn from(mut other: VecDeque<T, A>) -> Self {
|
||||
|
||||
#[stable(feature = "std_collections_from_array", since = "1.56.0")]
|
||||
impl<T, const N: usize> From<[T; N]> for VecDeque<T> {
|
||||
/// Converts a `[T; N]` into a `VecDeque<T>`.
|
||||
///
|
||||
/// ```
|
||||
/// use std::collections::VecDeque;
|
||||
///
|
||||
|
@ -2908,10 +2908,6 @@ fn from(s: &mut [T]) -> Vec<T> {
|
||||
#[cfg(not(no_global_oom_handling))]
|
||||
#[stable(feature = "vec_from_array", since = "1.44.0")]
|
||||
impl<T, const N: usize> From<[T; N]> for Vec<T> {
|
||||
#[cfg(not(test))]
|
||||
fn from(s: [T; N]) -> Vec<T> {
|
||||
<[T]>::into_vec(box s)
|
||||
}
|
||||
/// Allocate a `Vec<T>` and move `s`'s items into it.
|
||||
///
|
||||
/// # Examples
|
||||
@ -2919,6 +2915,11 @@ fn from(s: &mut [T]) -> Vec<T> {
|
||||
/// ```
|
||||
/// assert_eq!(Vec::from([1, 2, 3]), vec![1, 2, 3]);
|
||||
/// ```
|
||||
#[cfg(not(test))]
|
||||
fn from(s: [T; N]) -> Vec<T> {
|
||||
<[T]>::into_vec(box s)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
fn from(s: [T; N]) -> Vec<T> {
|
||||
crate::slice::into_vec(box s)
|
||||
|
@ -315,6 +315,7 @@ fn cmp(&self, other: &Cell<T>) -> Ordering {
|
||||
#[stable(feature = "cell_from", since = "1.12.0")]
|
||||
#[rustc_const_unstable(feature = "const_convert", issue = "88674")]
|
||||
impl<T> const From<T> for Cell<T> {
|
||||
/// Creates a new `Cell<T>` containing the given value.
|
||||
fn from(t: T) -> Cell<T> {
|
||||
Cell::new(t)
|
||||
}
|
||||
@ -1244,6 +1245,7 @@ fn cmp(&self, other: &RefCell<T>) -> Ordering {
|
||||
#[stable(feature = "cell_from", since = "1.12.0")]
|
||||
#[rustc_const_unstable(feature = "const_convert", issue = "88674")]
|
||||
impl<T> const From<T> for RefCell<T> {
|
||||
/// Creates a new `RefCell<T>` containing the given value.
|
||||
fn from(t: T) -> RefCell<T> {
|
||||
RefCell::new(t)
|
||||
}
|
||||
@ -1986,6 +1988,7 @@ fn default() -> UnsafeCell<T> {
|
||||
#[stable(feature = "cell_from", since = "1.12.0")]
|
||||
#[rustc_const_unstable(feature = "const_convert", issue = "88674")]
|
||||
impl<T> const From<T> for UnsafeCell<T> {
|
||||
/// Creates a new `UnsafeCell<T>` containing the given value.
|
||||
fn from(t: T) -> UnsafeCell<T> {
|
||||
UnsafeCell::new(t)
|
||||
}
|
||||
|
@ -538,6 +538,10 @@ impl<T, U> Into<U> for T
|
||||
where
|
||||
U: From<T>,
|
||||
{
|
||||
/// Calls `U::from(self)`.
|
||||
///
|
||||
/// That is, this conversion is whatever the implementation of
|
||||
/// <code>[From]<T> for U</code> chooses to do.
|
||||
fn into(self) -> U {
|
||||
U::from(self)
|
||||
}
|
||||
@ -547,6 +551,7 @@ fn into(self) -> U {
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
#[rustc_const_unstable(feature = "const_convert", issue = "88674")]
|
||||
impl<T> const From<T> for T {
|
||||
/// Returns the argument unchanged.
|
||||
fn from(t: T) -> T {
|
||||
t
|
||||
}
|
||||
|
@ -75,6 +75,7 @@ impl<T: Eq> Eq for OnceCell<T> {}
|
||||
|
||||
#[unstable(feature = "once_cell", issue = "74465")]
|
||||
impl<T> const From<T> for OnceCell<T> {
|
||||
/// Creates a new `OnceCell<T>` which already contains the given `value`.
|
||||
fn from(value: T) -> Self {
|
||||
OnceCell { inner: UnsafeCell::new(Some(value)) }
|
||||
}
|
||||
|
@ -714,6 +714,9 @@ fn from(unique: Unique<T>) -> Self {
|
||||
#[stable(feature = "nonnull", since = "1.25.0")]
|
||||
#[rustc_const_unstable(feature = "const_convert", issue = "88674")]
|
||||
impl<T: ?Sized> const From<&mut T> for NonNull<T> {
|
||||
/// Converts a `&mut T` to a `NonNull<T>`.
|
||||
///
|
||||
/// This conversion is safe and infallible since references cannot be null.
|
||||
#[inline]
|
||||
fn from(reference: &mut T) -> Self {
|
||||
// SAFETY: A mutable reference cannot be null.
|
||||
@ -724,6 +727,9 @@ fn from(reference: &mut T) -> Self {
|
||||
#[stable(feature = "nonnull", since = "1.25.0")]
|
||||
#[rustc_const_unstable(feature = "const_convert", issue = "88674")]
|
||||
impl<T: ?Sized> const From<&T> for NonNull<T> {
|
||||
/// Converts a `&T` to a `NonNull<T>`.
|
||||
///
|
||||
/// This conversion is safe and infallible since references cannot be null.
|
||||
#[inline]
|
||||
fn from(reference: &T) -> Self {
|
||||
// SAFETY: A reference cannot be null, so the conditions for
|
||||
|
@ -178,6 +178,9 @@ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
|
||||
#[unstable(feature = "ptr_internals", issue = "none")]
|
||||
impl<T: ?Sized> const From<&mut T> for Unique<T> {
|
||||
/// Converts a `&mut T` to a `Unique<T>`.
|
||||
///
|
||||
/// This conversion is infallible since references cannot be null.
|
||||
#[inline]
|
||||
fn from(reference: &mut T) -> Self {
|
||||
// SAFETY: A mutable reference cannot be null
|
||||
|
@ -1294,6 +1294,7 @@ fn from(b: bool) -> Self {
|
||||
#[stable(feature = "atomic_from", since = "1.23.0")]
|
||||
#[rustc_const_unstable(feature = "const_convert", issue = "88674")]
|
||||
impl<T> const From<*mut T> for AtomicPtr<T> {
|
||||
/// Converts a `*mut T` into an `AtomicPtr<T>`.
|
||||
#[inline]
|
||||
fn from(p: *mut T) -> Self {
|
||||
Self::new(p)
|
||||
|
@ -243,7 +243,7 @@ pub fn map_err<U, F>(self, f: F) -> Poll<Option<Result<T, U>>>
|
||||
#[stable(feature = "futures_api", since = "1.36.0")]
|
||||
#[rustc_const_unstable(feature = "const_convert", issue = "88674")]
|
||||
impl<T> const From<T> for Poll<T> {
|
||||
/// Convert to a `Ready` variant.
|
||||
/// Moves the value into a [`Poll::Ready`] to make a `Poll<T>`.
|
||||
///
|
||||
/// # Example
|
||||
///
|
||||
|
@ -848,6 +848,8 @@ fn borrow(&self) -> &CStr {
|
||||
|
||||
#[stable(feature = "cstring_from_cow_cstr", since = "1.28.0")]
|
||||
impl<'a> From<Cow<'a, CStr>> for CString {
|
||||
/// Converts a `Cow<'a, CStr>` into a `CString`, by copying the contents if they are
|
||||
/// borrowed.
|
||||
#[inline]
|
||||
fn from(s: Cow<'a, CStr>) -> Self {
|
||||
s.into_owned()
|
||||
@ -856,6 +858,8 @@ fn from(s: Cow<'a, CStr>) -> Self {
|
||||
|
||||
#[stable(feature = "box_from_c_str", since = "1.17.0")]
|
||||
impl From<&CStr> for Box<CStr> {
|
||||
/// Converts a `&CStr` into a `Box<CStr>`,
|
||||
/// by copying the contents into a newly allocated [`Box`].
|
||||
fn from(s: &CStr) -> Box<CStr> {
|
||||
let boxed: Box<[u8]> = Box::from(s.to_bytes_with_nul());
|
||||
unsafe { Box::from_raw(Box::into_raw(boxed) as *mut CStr) }
|
||||
@ -864,6 +868,8 @@ fn from(s: &CStr) -> Box<CStr> {
|
||||
|
||||
#[stable(feature = "box_from_cow", since = "1.45.0")]
|
||||
impl From<Cow<'_, CStr>> for Box<CStr> {
|
||||
/// Converts a `Cow<'a, CStr>` into a `Box<CStr>`,
|
||||
/// by copying the contents if they are borrowed.
|
||||
#[inline]
|
||||
fn from(cow: Cow<'_, CStr>) -> Box<CStr> {
|
||||
match cow {
|
||||
@ -960,6 +966,8 @@ fn from(s: CString) -> Arc<CStr> {
|
||||
|
||||
#[stable(feature = "shared_from_slice2", since = "1.24.0")]
|
||||
impl From<&CStr> for Arc<CStr> {
|
||||
/// Converts a `&CStr` into a `Arc<CStr>`,
|
||||
/// by copying the contents into a newly allocated [`Arc`].
|
||||
#[inline]
|
||||
fn from(s: &CStr) -> Arc<CStr> {
|
||||
let arc: Arc<[u8]> = Arc::from(s.to_bytes_with_nul());
|
||||
@ -979,6 +987,8 @@ fn from(s: CString) -> Rc<CStr> {
|
||||
|
||||
#[stable(feature = "shared_from_slice2", since = "1.24.0")]
|
||||
impl From<&CStr> for Rc<CStr> {
|
||||
/// Converts a `&CStr` into a `Rc<CStr>`,
|
||||
/// by copying the contents into a newly allocated [`Rc`].
|
||||
#[inline]
|
||||
fn from(s: &CStr) -> Rc<CStr> {
|
||||
let rc: Rc<[u8]> = Rc::from(s.to_bytes_with_nul());
|
||||
@ -1504,6 +1514,7 @@ fn clone_into(&self, target: &mut CString) {
|
||||
|
||||
#[stable(feature = "cstring_asref", since = "1.7.0")]
|
||||
impl From<&CStr> for CString {
|
||||
/// Copies the contents of the `&CStr` into a newly allocated `CString`.
|
||||
fn from(s: &CStr) -> CString {
|
||||
s.to_owned()
|
||||
}
|
||||
|
@ -371,6 +371,8 @@ fn from(s: String) -> OsString {
|
||||
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
impl<T: ?Sized + AsRef<OsStr>> From<&T> for OsString {
|
||||
/// Copies any value implementing <code>[AsRef]<[OsStr]></code>
|
||||
/// into a newly allocated [`OsString`].
|
||||
fn from(s: &T) -> OsString {
|
||||
s.as_ref().to_os_string()
|
||||
}
|
||||
@ -861,6 +863,7 @@ pub fn eq_ignore_ascii_case<S: AsRef<OsStr>>(&self, other: S) -> bool {
|
||||
|
||||
#[stable(feature = "box_from_os_str", since = "1.17.0")]
|
||||
impl From<&OsStr> for Box<OsStr> {
|
||||
/// Copies the string into a newly allocated <code>[Box]<[OsStr]></code>.
|
||||
#[inline]
|
||||
fn from(s: &OsStr) -> Box<OsStr> {
|
||||
let rw = Box::into_raw(s.inner.into_box()) as *mut OsStr;
|
||||
@ -870,6 +873,8 @@ fn from(s: &OsStr) -> Box<OsStr> {
|
||||
|
||||
#[stable(feature = "box_from_cow", since = "1.45.0")]
|
||||
impl From<Cow<'_, OsStr>> for Box<OsStr> {
|
||||
/// Converts a `Cow<'a, OsStr>` into a <code>[Box]<[OsStr]></code>,
|
||||
/// by copying the contents if they are borrowed.
|
||||
#[inline]
|
||||
fn from(cow: Cow<'_, OsStr>) -> Box<OsStr> {
|
||||
match cow {
|
||||
@ -918,6 +923,7 @@ fn from(s: OsString) -> Arc<OsStr> {
|
||||
|
||||
#[stable(feature = "shared_from_slice2", since = "1.24.0")]
|
||||
impl From<&OsStr> for Arc<OsStr> {
|
||||
/// Copies the string into a newly allocated <code>[Arc]<[OsStr]></code>.
|
||||
#[inline]
|
||||
fn from(s: &OsStr) -> Arc<OsStr> {
|
||||
let arc = s.inner.into_arc();
|
||||
@ -937,6 +943,7 @@ fn from(s: OsString) -> Rc<OsStr> {
|
||||
|
||||
#[stable(feature = "shared_from_slice2", since = "1.24.0")]
|
||||
impl From<&OsStr> for Rc<OsStr> {
|
||||
/// Copies the string into a newly allocated <code>[Rc]<[OsStr]></code>.
|
||||
#[inline]
|
||||
fn from(s: &OsStr) -> Rc<OsStr> {
|
||||
let rc = s.inner.into_rc();
|
||||
@ -946,6 +953,7 @@ fn from(s: &OsStr) -> Rc<OsStr> {
|
||||
|
||||
#[stable(feature = "cow_from_osstr", since = "1.28.0")]
|
||||
impl<'a> From<OsString> for Cow<'a, OsStr> {
|
||||
/// Moves the string into a [`Cow::Owned`].
|
||||
#[inline]
|
||||
fn from(s: OsString) -> Cow<'a, OsStr> {
|
||||
Cow::Owned(s)
|
||||
@ -954,6 +962,7 @@ fn from(s: OsString) -> Cow<'a, OsStr> {
|
||||
|
||||
#[stable(feature = "cow_from_osstr", since = "1.28.0")]
|
||||
impl<'a> From<&'a OsStr> for Cow<'a, OsStr> {
|
||||
/// Converts the string reference into a [`Cow::Borrowed`].
|
||||
#[inline]
|
||||
fn from(s: &'a OsStr) -> Cow<'a, OsStr> {
|
||||
Cow::Borrowed(s)
|
||||
@ -962,6 +971,7 @@ fn from(s: &'a OsStr) -> Cow<'a, OsStr> {
|
||||
|
||||
#[stable(feature = "cow_from_osstr", since = "1.28.0")]
|
||||
impl<'a> From<&'a OsString> for Cow<'a, OsStr> {
|
||||
/// Converts the string reference into a [`Cow::Borrowed`].
|
||||
#[inline]
|
||||
fn from(s: &'a OsString) -> Cow<'a, OsStr> {
|
||||
Cow::Borrowed(s.as_os_str())
|
||||
@ -970,6 +980,8 @@ fn from(s: &'a OsString) -> Cow<'a, OsStr> {
|
||||
|
||||
#[stable(feature = "osstring_from_cow_osstr", since = "1.28.0")]
|
||||
impl<'a> From<Cow<'a, OsStr>> for OsString {
|
||||
/// Converts a `Cow<'a, OsStr>` into an [`OsString`],
|
||||
/// by copying the contents if they are borrowed.
|
||||
#[inline]
|
||||
fn from(s: Cow<'a, OsStr>) -> Self {
|
||||
s.into_owned()
|
||||
|
@ -1581,7 +1581,7 @@ fn from(cow: Cow<'_, Path>) -> Box<Path> {
|
||||
|
||||
#[stable(feature = "path_buf_from_box", since = "1.18.0")]
|
||||
impl From<Box<Path>> for PathBuf {
|
||||
/// Converts a `Box<Path>` into a `PathBuf`
|
||||
/// Converts a <code>[Box]<[Path]></code> into a [`PathBuf`].
|
||||
///
|
||||
/// This conversion does not allocate or copy memory.
|
||||
#[inline]
|
||||
@ -1592,7 +1592,7 @@ fn from(boxed: Box<Path>) -> PathBuf {
|
||||
|
||||
#[stable(feature = "box_from_path_buf", since = "1.20.0")]
|
||||
impl From<PathBuf> for Box<Path> {
|
||||
/// Converts a `PathBuf` into a `Box<Path>`
|
||||
/// Converts a [`PathBuf`] into a <code>[Box]<[Path]></code>.
|
||||
///
|
||||
/// This conversion currently should not allocate memory,
|
||||
/// but this behavior is not guaranteed on all platforms or in all future versions.
|
||||
@ -1612,7 +1612,7 @@ fn clone(&self) -> Self {
|
||||
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
impl<T: ?Sized + AsRef<OsStr>> From<&T> for PathBuf {
|
||||
/// Converts a borrowed `OsStr` to a `PathBuf`.
|
||||
/// Converts a borrowed [`OsStr`] to a [`PathBuf`].
|
||||
///
|
||||
/// Allocates a [`PathBuf`] and copies the data into it.
|
||||
#[inline]
|
||||
|
@ -1289,7 +1289,7 @@ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
|
||||
#[stable(feature = "stdio_from", since = "1.20.0")]
|
||||
impl From<ChildStdin> for Stdio {
|
||||
/// Converts a `ChildStdin` into a `Stdio`
|
||||
/// Converts a [`ChildStdin`] into a [`Stdio`].
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -1318,7 +1318,7 @@ fn from(child: ChildStdin) -> Stdio {
|
||||
|
||||
#[stable(feature = "stdio_from", since = "1.20.0")]
|
||||
impl From<ChildStdout> for Stdio {
|
||||
/// Converts a `ChildStdout` into a `Stdio`
|
||||
/// Converts a [`ChildStdout`] into a [`Stdio`].
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -1347,7 +1347,7 @@ fn from(child: ChildStdout) -> Stdio {
|
||||
|
||||
#[stable(feature = "stdio_from", since = "1.20.0")]
|
||||
impl From<ChildStderr> for Stdio {
|
||||
/// Converts a `ChildStderr` into a `Stdio`
|
||||
/// Converts a [`ChildStderr`] into a [`Stdio`].
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -1378,7 +1378,7 @@ fn from(child: ChildStderr) -> Stdio {
|
||||
|
||||
#[stable(feature = "stdio_from", since = "1.20.0")]
|
||||
impl From<fs::File> for Stdio {
|
||||
/// Converts a `File` into a `Stdio`
|
||||
/// Converts a [`File`](fs::File) into a [`Stdio`].
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
|
Loading…
Reference in New Issue
Block a user