src/libcore/convert.rs

   1 //! Traits for conversions between types.
   2 //!
   3 //! The traits in this module provide a way to convert from one type to another type.
   4 //! Each trait serves a different purpose:
   5 //!
   6 //! - Implement the [`AsRef`] trait for cheap reference-to-reference conversions
   7 //! - Implement the [`AsMut`] trait for cheap mutable-to-mutable conversions
   8 //! - Implement the [`From`] trait for consuming value-to-value conversions
   9 //! - Implement the [`Into`] trait for consuming value-to-value conversions to types
  10 //!   outside the current crate
  11 //! - The [`TryFrom`] and [`TryInto`] traits behave like [`From`] and [`Into`],
  12 //!   but should be implemented when the conversion can fail.
  13 //!
  14 //! The traits in this module are often used as trait bounds for generic functions such that to
  15 //! arguments of multiple types are supported. See the documentation of each trait for examples.
  16 //!
  17 //! As a library author, you should always prefer implementing [`From<T>`][`From`] or
  18 //! [`TryFrom<T>`][`TryFrom`] rather than [`Into<U>`][`Into`] or [`TryInto<U>`][`TryInto`],
  19 //! as [`From`] and [`TryFrom`] provide greater flexibility and offer
  20 //! equivalent [`Into`] or [`TryInto`] implementations for free, thanks to a
  21 //! blanket implementation in the standard library. Only implement [`Into`] or [`TryInto`]
  22 //! when a conversion to a type outside the current crate is required.
  23 //!
  24 //! # Generic Implementations
  25 //!
  26 //! - [`AsRef`] and [`AsMut`] auto-dereference if the inner type is a reference
  27 //! - [`From`]`<U> for T` implies [`Into`]`<T> for U`
  28 //! - [`TryFrom`]`<U> for T` implies [`TryInto`]`<T> for U`
  29 //! - [`From`] and [`Into`] are reflexive, which means that all types can
  30 //!   `into` themselves and `from` themselves
  31 //!
  32 //! See each trait for usage examples.
  33 //!
  34 //! [`Into`]: trait.Into.html
  35 //! [`From`]: trait.From.html
  36 //! [`TryFrom`]: trait.TryFrom.html
  37 //! [`TryInto`]: trait.TryInto.html
  38 //! [`AsRef`]: trait.AsRef.html
  39 //! [`AsMut`]: trait.AsMut.html
  40
  41 #![stable(feature = "rust1", since = "1.0.0")]
  42
  43 use crate::fmt;
  44
  45 /// An identity function.
  46 ///
  47 /// Two things are important to note about this function:
  48 ///
  49 /// - It is not always equivalent to a closure like `|x| x` since the
  50 ///   closure may coerce `x` into a different type.
  51 ///
  52 /// - It moves the input `x` passed to the function.
  53 ///
  54 /// While it might seem strange to have a function that just returns back the
  55 /// input, there are some interesting uses.
  56 ///
  57 /// # Examples
  58 ///
  59 /// Using `identity` to do nothing among other interesting functions:
  60 ///
  61 /// ```rust
  62 /// use std::convert::identity;
  63 ///
  64 /// fn manipulation(x: u32) -> u32 {
  65 ///     // Let's assume that this function does something interesting.
  66 ///     x + 1
  67 /// }
  68 ///
  69 /// let _arr = &[identity, manipulation];
  70 /// ```
  71 ///
  72 /// Using `identity` to get a function that changes nothing in a conditional:
  73 ///
  74 /// ```rust
  75 /// use std::convert::identity;
  76 ///
  77 /// # let condition = true;
  78 ///
  79 /// # fn manipulation(x: u32) -> u32 { x + 1 }
  80 ///
  81 /// let do_stuff = if condition { manipulation } else { identity };
  82 ///
  83 /// // do more interesting stuff..
  84 ///
  85 /// let _results = do_stuff(42);
  86 /// ```
  87 ///
  88 /// Using `identity` to keep the `Some` variants of an iterator of `Option<T>`:
  89 ///
  90 /// ```rust
  91 /// use std::convert::identity;
  92 ///
  93 /// let iter = vec![Some(1), None, Some(3)].into_iter();
  94 /// let filtered = iter.filter_map(identity).collect::<Vec<_>>();
  95 /// assert_eq!(vec![1, 3], filtered);
  96 /// ```
  97 #[stable(feature = "convert_id", since = "1.33.0")]
  98 #[inline]
  99 pub const fn identity<T>(x: T) -> T { x }
 100
 101 /// Used to do a cheap reference-to-reference conversion.
 102 ///
 103 /// This trait is similar to [`AsMut`] which is used for converting between mutable references.
 104 /// If you need to do a costly conversion it is better to implement [`From`] with type
 105 /// `&T` or write a custom function.
 106 ///
 107 /// `AsRef` has the same signature as [`Borrow`], but `Borrow` is different in few aspects:
 108 ///
 109 /// - Unlike `AsRef`, `Borrow` has a blanket impl for any `T`, and can be used to accept either
 110 ///   a reference or a value.
 111 /// - `Borrow` also requires that `Hash`, `Eq` and `Ord` for borrowed value are
 112 ///   equivalent to those of the owned value. For this reason, if you want to
 113 ///   borrow only a single field of a struct you can implement `AsRef`, but not `Borrow`.
 114 ///
 115 /// [`Borrow`]: ../../std/borrow/trait.Borrow.html
 116 ///
 117 /// **Note: This trait must not fail**. If the conversion can fail, use a
 118 /// dedicated method which returns an [`Option<T>`] or a [`Result<T, E>`].
 119 ///
 120 /// [`Option<T>`]: ../../std/option/enum.Option.html
 121 /// [`Result<T, E>`]: ../../std/result/enum.Result.html
 122 ///
 123 /// # Generic Implementations
 124 ///
 125 /// - `AsRef` auto-dereferences if the inner type is a reference or a mutable
 126 ///   reference (e.g.: `foo.as_ref()` will work the same if `foo` has type
 127 ///   `&mut Foo` or `&&mut Foo`)
 128 ///
 129 /// # Examples
 130 ///
 131 /// By using trait bounds we can accept arguments of different types as long as they can be
 132 /// converted a the specified type `T`.
 133 ///
 134 /// For example: By creating a generic function that takes an `AsRef<str>` we express that we
 135 /// want to accept all references that can be converted to `&str` as an argument.
 136 /// Since both [`String`] and `&str` implement `AsRef<str>` we can accept both as input argument.
 137 ///
 138 /// [`String`]: ../../std/string/struct.String.html
 139 ///
 140 /// ```
 141 /// fn is_hello<T: AsRef<str>>(s: T) {
 142 ///    assert_eq!("hello", s.as_ref());
 143 /// }
 144 ///
 145 /// let s = "hello";
 146 /// is_hello(s);
 147 ///
 148 /// let s = "hello".to_string();
 149 /// is_hello(s);
 150 /// ```
 151 #[stable(feature = "rust1", since = "1.0.0")]
 152 pub trait AsRef<T: ?Sized> {
 153     /// Performs the conversion.
 154     #[stable(feature = "rust1", since = "1.0.0")]
 155     fn as_ref(&self) -> &T;
 156 }
 157
 158 /// Used to do a cheap mutable-to-mutable reference conversion.
 159 ///
 160 /// This trait is similar to [`AsRef`] but used for converting between mutable
 161 /// references. If you need to do a costly conversion it is better to
 162 /// implement [`From`] with type `&mut T` or write a custom function.
 163 ///
 164 /// **Note: This trait must not fail**. If the conversion can fail, use a
 165 /// dedicated method which returns an [`Option<T>`] or a [`Result<T, E>`].
 166 ///
 167 /// [`Option<T>`]: ../../std/option/enum.Option.html
 168 /// [`Result<T, E>`]: ../../std/result/enum.Result.html
 169 ///
 170 /// # Generic Implementations
 171 ///
 172 /// - `AsMut` auto-dereferences if the inner type is a mutable reference
 173 ///   (e.g.: `foo.as_mut()` will work the same if `foo` has type `&mut Foo`
 174 ///   or `&mut &mut Foo`)
 175 ///
 176 /// # Examples
 177 ///
 178 /// Using `AsMut` as trait bound for a generic function we can accept all mutable references
 179 /// that can be converted to type `&mut T`. Because [`Box<T>`] implements `AsMut<T>` we can
 180 /// write a function `add_one`that takes all arguments that can be converted to `&mut u64`.
 181 /// Because [`Box<T>`] implements `AsMut<T>` `add_one` accepts arguments of type
 182 /// `&mut Box<u64>` as well:
 183 ///
 184 /// ```
 185 /// fn add_one<T: AsMut<u64>>(num: &mut T) {
 186 ///     *num.as_mut() += 1;
 187 /// }
 188 ///
 189 /// let mut boxed_num = Box::new(0);
 190 /// add_one(&mut boxed_num);
 191 /// assert_eq!(*boxed_num, 1);
 192 /// ```
 193 ///
 194 /// [`Box<T>`]: ../../std/boxed/struct.Box.html
 195 #[stable(feature = "rust1", since = "1.0.0")]
 196 pub trait AsMut<T: ?Sized> {
 197     /// Performs the conversion.
 198     #[stable(feature = "rust1", since = "1.0.0")]
 199     fn as_mut(&mut self) -> &mut T;
 200 }
 201
 202 /// A value-to-value conversion that consumes the input value. The
 203 /// opposite of [`From`].
 204 ///
 205 /// One should only implement `Into` if a conversion to a type outside the current crate is
 206 /// required. Otherwise one should always prefer implementing [`From`] over `Into` because
 207 /// implementing [`From`] automatically provides one with a implementation of `Into` thanks to
 208 /// the blanket implementation in the standard library. [`From`] cannot do these type of
 209 /// conversions because of Rust's orphaning rules.
 210 ///
 211 /// **Note: This trait must not fail**. If the conversion can fail, use [`TryInto`].
 212 ///
 213 /// # Generic Implementations
 214 ///
 215 /// - [`From`]`<T> for U` implies `Into<U> for T`
 216 /// - `Into` is reflexive, which means that `Into<T> for T` is implemented
 217 ///
 218 /// # Implementing `Into` for conversions to external types
 219 ///
 220 /// If the destination type is not part of the current crate
 221 /// then you can't implement [`From`] directly.
 222 /// For example, take this code:
 223 ///
 224 /// ```compile_fail
 225 /// struct Wrapper<T>(Vec<T>);
 226 /// impl<T> From<Wrapper<T>> for Vec<T> {
 227 ///     fn from(w: Wrapper<T>) -> Vec<T> {
 228 ///         w.0
 229 ///     }
 230 /// }
 231 /// ```
 232 /// This will fail to compile because we cannot implement a trait for a type
 233 /// if both the trait and the type are not defined by the current crate.
 234 /// This is due to Rust's orphaning rules. To bypass this, you can implement `Into` directly:
 235 ///
 236 /// ```
 237 /// struct Wrapper<T>(Vec<T>);
 238 /// impl<T> Into<Vec<T>> for Wrapper<T> {
 239 ///     fn into(self) -> Vec<T> {
 240 ///         self.0
 241 ///     }
 242 /// }
 243 /// ```
 244 ///
 245 /// It is important to understand that `Into` does not provide a [`From`] implementation
 246 /// (as [`From`] does with `Into`). Therefore, you should always try to implement [`From`]
 247 /// and then fall back to `Into` if [`From`] can't be implemented.
 248 ///
 249 /// Prefer using `Into` over [`From`] when specifying trait bounds on a generic function
 250 /// to ensure that types that only implement `Into` can be used as well.
 251 ///
 252 /// # Examples
 253 ///
 254 /// [`String`] implements `Into<Vec<u8>>`:
 255 ///
 256 /// In order to express that we want a generic function to take all arguments that can be
 257 /// converted to a specified type `T`, we can use a trait bound of `Into<T>`.
 258 /// For example: The function `is_hello` takes all arguments that can be converted into a
 259 /// `Vec<u8>`.
 260 ///
 261 /// ```
 262 /// fn is_hello<T: Into<Vec<u8>>>(s: T) {
 263 ///    let bytes = b"hello".to_vec();
 264 ///    assert_eq!(bytes, s.into());
 265 /// }
 266 ///
 267 /// let s = "hello".to_string();
 268 /// is_hello(s);
 269 /// ```
 270 ///
 271 /// [`TryInto`]: trait.TryInto.html
 272 /// [`Option<T>`]: ../../std/option/enum.Option.html
 273 /// [`Result<T, E>`]: ../../std/result/enum.Result.html
 274 /// [`String`]: ../../std/string/struct.String.html
 275 /// [`From`]: trait.From.html
 276 /// [`into`]: trait.Into.html#tymethod.into
 277 #[stable(feature = "rust1", since = "1.0.0")]
 278 pub trait Into<T>: Sized {
 279     /// Performs the conversion.
 280     #[stable(feature = "rust1", since = "1.0.0")]
 281     fn into(self) -> T;
 282 }
 283
 284 /// Used to do value-to-value conversions while consuming the input value. It is the reciprocal of
 285 /// [`Into`].
 286 ///
 287 /// One should always prefer implementing `From` over [`Into`]
 288 /// because implementing `From` automatically provides one with a implementation of [`Into`]
 289 /// thanks to the blanket implementation in the standard library.
 290 ///
 291 /// Only implement [`Into`] if a conversion to a type outside the current crate is required.
 292 /// `From` cannot do these type of conversions because of Rust's orphaning rules.
 293 /// See [`Into`] for more details.
 294 ///
 295 /// Prefer using [`Into`] over using `From` when specifying trait bounds on a generic function.
 296 /// This way, types that directly implement [`Into`] can be used as arguments as well.
 297 ///
 298 /// The `From` is also very useful when performing error handling. When constructing a function
 299 /// that is capable of failing, the return type will generally be of the form `Result<T, E>`.
 300 /// The `From` trait simplifies error handling by allowing a function to return a single error type
 301 /// that encapsulate multiple error types. See the "Examples" section and [the book][book] for more
 302 /// details.
 303 ///
 304 /// **Note: This trait must not fail**. If the conversion can fail, use [`TryFrom`].
 305 ///
 306 /// # Generic Implementations
 307 ///
 308 /// - `From<T> for U` implies [`Into`]`<U> for T`
 309 /// - `From` is reflexive, which means that `From<T> for T` is implemented
 310 ///
 311 /// # Examples
 312 ///
 313 /// [`String`] implements `From<&str>`:
 314 ///
 315 /// An explicit conversion from a `&str` to a String is done as follows:
 316 ///
 317 /// ```
 318 /// let string = "hello".to_string();
 319 /// let other_string = String::from("hello");
 320 ///
 321 /// assert_eq!(string, other_string);
 322 /// ```
 323 ///
 324 /// While performing error handling it is often useful to implement `From` for your own error type.
 325 /// By converting underlying error types to our own custom error type that encapsulates the
 326 /// underlying error type, we can return a single error type without losing information on the
 327 /// underlying cause. The '?' operator automatically converts the underlying error type to our
 328 /// custom error type by calling `Into<CliError>::into` which is automatically provided when
 329 /// implementing `From`. The compiler then infers which implementation of `Into` should be used.
 330 ///
 331 /// ```
 332 /// use std::fs;
 333 /// use std::io;
 334 /// use std::num;
 335 ///
 336 /// enum CliError {
 337 ///     IoError(io::Error),
 338 ///     ParseError(num::ParseIntError),
 339 /// }
 340 ///
 341 /// impl From<io::Error> for CliError {
 342 ///     fn from(error: io::Error) -> Self {
 343 ///         CliError::IoError(error)
 344 ///     }
 345 /// }
 346 ///
 347 /// impl From<num::ParseIntError> for CliError {
 348 ///     fn from(error: num::ParseIntError) -> Self {
 349 ///         CliError::ParseError(error)
 350 ///     }
 351 /// }
 352 ///
 353 /// fn open_and_parse_file(file_name: &str) -> Result<i32, CliError> {
 354 ///     let mut contents = fs::read_to_string(&file_name)?;
 355 ///     let num: i32 = contents.trim().parse()?;
 356 ///     Ok(num)
 357 /// }
 358 /// ```
 359 ///
 360 /// [`TryFrom`]: trait.TryFrom.html
 361 /// [`Option<T>`]: ../../std/option/enum.Option.html
 362 /// [`Result<T, E>`]: ../../std/result/enum.Result.html
 363 /// [`String`]: ../../std/string/struct.String.html
 364 /// [`Into`]: trait.Into.html
 365 /// [`from`]: trait.From.html#tymethod.from
 366 /// [book]: ../../book/ch09-00-error-handling.html
 367 #[stable(feature = "rust1", since = "1.0.0")]
 368 #[rustc_on_unimplemented(
 369     on(
 370         all(_Self="&str", T="std::string::String"),
 371         note="to coerce a `{T}` into a `{Self}`, use `&*` as a prefix",
 372     )
 373 )]
 374 pub trait From<T>: Sized {
 375     /// Performs the conversion.
 376     #[stable(feature = "rust1", since = "1.0.0")]
 377     fn from(_: T) -> Self;
 378 }
 379
 380 /// An attempted conversion that consumes `self`, which may or may not be
 381 /// expensive.
 382 ///
 383 /// Library authors should usually not directly implement this trait,
 384 /// but should prefer implementing the [`TryFrom`] trait, which offers
 385 /// greater flexibility and provides an equivalent `TryInto`
 386 /// implementation for free, thanks to a blanket implementation in the
 387 /// standard library. For more information on this, see the
 388 /// documentation for [`Into`].
 389 ///
 390 /// # Implementing `TryInto`
 391 ///
 392 /// This suffers the same restrictions and reasoning as implementing
 393 /// [`Into`], see there for details.
 394 ///
 395 /// [`TryFrom`]: trait.TryFrom.html
 396 /// [`Into`]: trait.Into.html
 397 #[stable(feature = "try_from", since = "1.34.0")]
 398 pub trait TryInto<T>: Sized {
 399     /// The type returned in the event of a conversion error.
 400     #[stable(feature = "try_from", since = "1.34.0")]
 401     type Error;
 402
 403     /// Performs the conversion.
 404     #[stable(feature = "try_from", since = "1.34.0")]
 405     fn try_into(self) -> Result<T, Self::Error>;
 406 }
 407
 408 /// Simple and safe type conversions that may fail in a controlled
 409 /// way under some circumstances. It is the reciprocal of [`TryInto`].
 410 ///
 411 /// This is useful when you are doing a type conversion that may
 412 /// trivially succeed but may also need special handling.
 413 /// For example, there is no way to convert an `i64` into an `i32`
 414 /// using the [`From`] trait, because an `i64` may contain a value
 415 /// that an `i32` cannot represent and so the conversion would lose data.
 416 /// This might be handled by truncating the `i64` to an `i32` (essentially
 417 /// giving the `i64`'s value modulo `i32::MAX`) or by simply returning
 418 /// `i32::MAX`, or by some other method.  The `From` trait is intended
 419 /// for perfect conversions, so the `TryFrom` trait informs the
 420 /// programmer when a type conversion could go bad and lets them
 421 /// decide how to handle it.
 422 ///
 423 /// # Generic Implementations
 424 ///
 425 /// - `TryFrom<T> for U` implies [`TryInto`]`<U> for T`
 426 /// - [`try_from`] is reflexive, which means that `TryFrom<T> for T`
 427 /// is implemented and cannot fail -- the associated `Error` type for
 428 /// calling `T::try_from()` on a value of type `T` is `Infallible`.
 429 /// When the `!` type is stablized `Infallible` and `!` will be
 430 /// equivalent.
 431 ///
 432 /// `TryFrom<T>` can be implemented as follows:
 433 ///
 434 /// ```
 435 /// use std::convert::TryFrom;
 436 ///
 437 /// struct SuperiorThanZero(i32);
 438 ///
 439 /// impl TryFrom<i32> for SuperiorThanZero {
 440 ///     type Error = &'static str;
 441 ///
 442 ///     fn try_from(value: i32) -> Result<Self, Self::Error> {
 443 ///         if value < 0 {
 444 ///             Err("SuperiorThanZero only accepts value superior than zero!")
 445 ///         } else {
 446 ///             Ok(SuperiorThanZero(value))
 447 ///         }
 448 ///     }
 449 /// }
 450 /// ```
 451 ///
 452 /// # Examples
 453 ///
 454 /// As described, [`i32`] implements `TryFrom<i64>`:
 455 ///
 456 /// ```
 457 /// use std::convert::TryFrom;
 458 ///
 459 /// let big_number = 1_000_000_000_000i64;
 460 /// // Silently truncates `big_number`, requires detecting
 461 /// // and handling the truncation after the fact.
 462 /// let smaller_number = big_number as i32;
 463 /// assert_eq!(smaller_number, -727379968);
 464 ///
 465 /// // Returns an error because `big_number` is too big to
 466 /// // fit in an `i32`.
 467 /// let try_smaller_number = i32::try_from(big_number);
 468 /// assert!(try_smaller_number.is_err());
 469 ///
 470 /// // Returns `Ok(3)`.
 471 /// let try_successful_smaller_number = i32::try_from(3);
 472 /// assert!(try_successful_smaller_number.is_ok());
 473 /// ```
 474 ///
 475 /// [`try_from`]: trait.TryFrom.html#tymethod.try_from
 476 /// [`TryInto`]: trait.TryInto.html
 477 #[stable(feature = "try_from", since = "1.34.0")]
 478 pub trait TryFrom<T>: Sized {
 479     /// The type returned in the event of a conversion error.
 480     #[stable(feature = "try_from", since = "1.34.0")]
 481     type Error;
 482
 483     /// Performs the conversion.
 484     #[stable(feature = "try_from", since = "1.34.0")]
 485     fn try_from(value: T) -> Result<Self, Self::Error>;
 486 }
 487
 488 ////////////////////////////////////////////////////////////////////////////////
 489 // GENERIC IMPLS
 490 ////////////////////////////////////////////////////////////////////////////////
 491
 492 // As lifts over &
 493 #[stable(feature = "rust1", since = "1.0.0")]
 494 impl<T: ?Sized, U: ?Sized> AsRef<U> for &T where T: AsRef<U>
 495 {
 496     fn as_ref(&self) -> &U {
 497         <T as AsRef<U>>::as_ref(*self)
 498     }
 499 }
 500
 501 // As lifts over &mut
 502 #[stable(feature = "rust1", since = "1.0.0")]
 503 impl<T: ?Sized, U: ?Sized> AsRef<U> for &mut T where T: AsRef<U>
 504 {
 505     fn as_ref(&self) -> &U {
 506         <T as AsRef<U>>::as_ref(*self)
 507     }
 508 }
 509
 510 // FIXME (#45742): replace the above impls for &/&mut with the following more general one:
 511 // // As lifts over Deref
 512 // impl<D: ?Sized + Deref, U: ?Sized> AsRef<U> for D where D::Target: AsRef<U> {
 513 //     fn as_ref(&self) -> &U {
 514 //         self.deref().as_ref()
 515 //     }
 516 // }
 517
 518 // AsMut lifts over &mut
 519 #[stable(feature = "rust1", since = "1.0.0")]
 520 impl<T: ?Sized, U: ?Sized> AsMut<U> for &mut T where T: AsMut<U>
 521 {
 522     fn as_mut(&mut self) -> &mut U {
 523         (*self).as_mut()
 524     }
 525 }
 526
 527 // FIXME (#45742): replace the above impl for &mut with the following more general one:
 528 // // AsMut lifts over DerefMut
 529 // impl<D: ?Sized + Deref, U: ?Sized> AsMut<U> for D where D::Target: AsMut<U> {
 530 //     fn as_mut(&mut self) -> &mut U {
 531 //         self.deref_mut().as_mut()
 532 //     }
 533 // }
 534
 535 // From implies Into
 536 #[stable(feature = "rust1", since = "1.0.0")]
 537 impl<T, U> Into<U> for T where U: From<T>
 538 {
 539     fn into(self) -> U {
 540         U::from(self)
 541     }
 542 }
 543
 544 // From (and thus Into) is reflexive
 545 #[stable(feature = "rust1", since = "1.0.0")]
 546 impl<T> From<T> for T {
 547     fn from(t: T) -> T { t }
 548 }
 549
 550
 551 // TryFrom implies TryInto
 552 #[stable(feature = "try_from", since = "1.34.0")]
 553 impl<T, U> TryInto<U> for T where U: TryFrom<T>
 554 {
 555     type Error = U::Error;
 556
 557     fn try_into(self) -> Result<U, U::Error> {
 558         U::try_from(self)
 559     }
 560 }
 561
 562 // Infallible conversions are semantically equivalent to fallible conversions
 563 // with an uninhabited error type.
 564 #[stable(feature = "try_from", since = "1.34.0")]
 565 impl<T, U> TryFrom<U> for T where U: Into<T> {
 566     type Error = Infallible;
 567
 568     fn try_from(value: U) -> Result<Self, Self::Error> {
 569         Ok(U::into(value))
 570     }
 571 }
 572
 573 ////////////////////////////////////////////////////////////////////////////////
 574 // CONCRETE IMPLS
 575 ////////////////////////////////////////////////////////////////////////////////
 576
 577 #[stable(feature = "rust1", since = "1.0.0")]
 578 impl<T> AsRef<[T]> for [T] {
 579     fn as_ref(&self) -> &[T] {
 580         self
 581     }
 582 }
 583
 584 #[stable(feature = "rust1", since = "1.0.0")]
 585 impl<T> AsMut<[T]> for [T] {
 586     fn as_mut(&mut self) -> &mut [T] {
 587         self
 588     }
 589 }
 590
 591 #[stable(feature = "rust1", since = "1.0.0")]
 592 impl AsRef<str> for str {
 593     #[inline]
 594     fn as_ref(&self) -> &str {
 595         self
 596     }
 597 }
 598
 599 ////////////////////////////////////////////////////////////////////////////////
 600 // THE NO-ERROR ERROR TYPE
 601 ////////////////////////////////////////////////////////////////////////////////
 602
 603 /// The error type for errors that can never happen.
 604 ///
 605 /// Since this enum has no variant, a value of this type can never actually exist.
 606 /// This can be useful for generic APIs that use [`Result`] and parameterize the error type,
 607 /// to indicate that the result is always [`Ok`].
 608 ///
 609 /// For example, the [`TryFrom`] trait (conversion that returns a [`Result`])
 610 /// has a blanket implementation for all types where a reverse [`Into`] implementation exists.
 611 ///
 612 /// ```ignore (illustrates std code, duplicating the impl in a doctest would be an error)
 613 /// impl<T, U> TryFrom<U> for T where U: Into<T> {
 614 ///     type Error = Infallible;
 615 ///
 616 ///     fn try_from(value: U) -> Result<Self, Infallible> {
 617 ///         Ok(U::into(value))  // Never returns `Err`
 618 ///     }
 619 /// }
 620 /// ```
 621 ///
 622 /// # Future compatibility
 623 ///
 624 /// This enum has the same role as [the `!` “never” type][never],
 625 /// which is unstable in this version of Rust.
 626 /// When `!` is stabilized, we plan to make `Infallible` a type alias to it:
 627 ///
 628 /// ```ignore (illustrates future std change)
 629 /// pub type Infallible = !;
 630 /// ```
 631 ///
 632 /// … and eventually deprecate `Infallible`.
 633 ///
 634 ///
 635 /// However there is one case where `!` syntax can be used
 636 /// before `!` is stabilized as a full-fleged type: in the position of a function’s return type.
 637 /// Specifically, it is possible implementations for two different function pointer types:
 638 ///
 639 /// ```
 640 /// trait MyTrait {}
 641 /// impl MyTrait for fn() -> ! {}
 642 /// impl MyTrait for fn() -> std::convert::Infallible {}
 643 /// ```
 644 ///
 645 /// With `Infallible` being an enum, this code is valid.
 646 /// However when `Infallible` becomes an alias for the never type,
 647 /// the two `impl`s will start to overlap
 648 /// and therefore will be disallowed by the language’s trait coherence rules.
 649 ///
 650 /// [`Ok`]: ../result/enum.Result.html#variant.Ok
 651 /// [`Result`]: ../result/enum.Result.html
 652 /// [`TryFrom`]: trait.TryFrom.html
 653 /// [`Into`]: trait.Into.html
 654 /// [never]: ../../std/primitive.never.html
 655 #[stable(feature = "convert_infallible", since = "1.34.0")]
 656 #[derive(Copy)]
 657 pub enum Infallible {}
 658
 659 #[stable(feature = "convert_infallible", since = "1.34.0")]
 660 impl Clone for Infallible {
 661     fn clone(&self) -> Infallible {
 662         match *self {}
 663     }
 664 }
 665
 666 #[stable(feature = "convert_infallible", since = "1.34.0")]
 667 impl fmt::Debug for Infallible {
 668     fn fmt(&self, _: &mut fmt::Formatter<'_>) -> fmt::Result {
 669         match *self {}
 670     }
 671 }
 672
 673 #[stable(feature = "convert_infallible", since = "1.34.0")]
 674 impl fmt::Display for Infallible {
 675     fn fmt(&self, _: &mut fmt::Formatter<'_>) -> fmt::Result {
 676         match *self {}
 677     }
 678 }
 679
 680 #[stable(feature = "convert_infallible", since = "1.34.0")]
 681 impl PartialEq for Infallible {
 682     fn eq(&self, _: &Infallible) -> bool {
 683         match *self {}
 684     }
 685 }
 686
 687 #[stable(feature = "convert_infallible", since = "1.34.0")]
 688 impl Eq for Infallible {}
 689
 690 #[stable(feature = "convert_infallible", since = "1.34.0")]
 691 impl PartialOrd for Infallible {
 692     fn partial_cmp(&self, _other: &Self) -> Option<crate::cmp::Ordering> {
 693         match *self {}
 694     }
 695 }
 696
 697 #[stable(feature = "convert_infallible", since = "1.34.0")]
 698 impl Ord for Infallible {
 699     fn cmp(&self, _other: &Self) -> crate::cmp::Ordering {
 700         match *self {}
 701     }
 702 }
 703
 704 #[stable(feature = "convert_infallible", since = "1.34.0")]
 705 impl From<!> for Infallible {
 706     fn from(x: !) -> Self {
 707         x
 708     }
 709 }