std::convert - Rust
Description: API documentation for the Rust `convert` mod in crate `std`.
Keywords: rust, rustlang, rust-lang, convert

# Module std::convert 1.0.0 [−] [src]

Traits for conversions between types.

The traits in this module provide a general way to talk about conversions from one type to another. They follow the standard Rust conventions of `as`/`into`/`from`.

Like many traits, these are often used as bounds for generic functions, to support arguments of multiple types.

- Impl the `As*` traits for reference-to-reference conversions
- Impl the `Into` trait when you want to consume the value in the conversion
- The `From` trait is the most flexible, useful for value and reference conversions
- The `TryFrom` and `TryInto` traits behave like `From` and `Into`, but allow for the conversion to fail

As a library author, you should prefer implementing `From<T>` or `TryFrom<T>` rather than `Into<U>` or `TryInto<U>`, as `From` and `TryFrom` provide greater flexibility and offer equivalent `Into` or `TryInto` implementations for free, thanks to a blanket implementation in the standard library.

# Generic impl

- `AsRef` and `AsMut` auto-dereference if the inner type is a reference
- `From<U> for T` implies `Into<T> for U`
- `TryFrom<U> for T` implies `TryInto<T> for U`
- `From` and `Into` are reflexive, which means that all types can `into()` themselves and `from()` themselves

See each trait for usage examples.

## Traits

AsMut | A cheap, mutable reference-to-mutable reference conversion.
AsRef | A cheap, reference-to-reference conversion.
From | Construct `Self` via a conversion.
Into | A conversion that consumes `self`, which may or may not be expensive.
TryFrom | [Unstable] Attempt to construct `Self` via a conversion.
TryInto | [Unstable] An attempted conversion that consumes `self`, which may or may not be expensive.

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)