W3cubDocs

/Rust

Trait std::convert::AsRef

pub trait AsRef<T> where    T: ?Sized, {
    fn as_ref(&self) -> &T;
}

Used to do a cheap reference-to-reference conversion.

This trait is similar to AsMut which is used for converting between mutable references. If you need to do a costly conversion it is better to implement From with type &T or write a custom function.

AsRef has the same signature as Borrow, but Borrow is different in few aspects:

  • Unlike AsRef, Borrow has a blanket impl for any T, and can be used to accept either a reference or a value.
  • Borrow also requires that Hash, Eq and Ord for borrowed value are equivalent to those of the owned value. For this reason, if you want to borrow only a single field of a struct you can implement AsRef, but not Borrow.

Note: This trait must not fail. If the conversion can fail, use a dedicated method which returns an Option<T> or a Result<T, E>.

Generic Implementations

  • AsRef auto-dereferences if the inner type is a reference or a mutable reference (e.g.: foo.as_ref() will work the same if foo has type &mut Foo or &&mut Foo)

Examples

By using trait bounds we can accept arguments of different types as long as they can be converted to the specified type T.

For example: By creating a generic function that takes an AsRef<str> we express that we want to accept all references that can be converted to &str as an argument. Since both String and &str implement AsRef<str> we can accept both as input argument.

fn is_hello<T: AsRef<str>>(s: T) {
   assert_eq!("hello", s.as_ref());
}

let s = "hello";
is_hello(s);

let s = "hello".to_string();
is_hello(s);

Required methods

fn as_ref(&self) -> &T

ⓘImportant traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'_, R: Read + ?Sized> Read for &'_ mut R
impl<'_, W: Write + ?Sized> Write for &'_ mut W

Performs the conversion.

Loading content...

Implementors

impl AsRef<[u8]> for str[src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl AsRef<[u8]> for String[src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl AsRef<str> for str[src]

impl AsRef<str> for String[src]

impl AsRef<CStr> for CStr[src]

impl AsRef<CStr> for CString[src]

impl AsRef<OsStr> for str[src]

impl AsRef<OsStr> for OsStr[src]

impl AsRef<OsStr> for OsString[src]

impl AsRef<OsStr> for Path[src]

impl AsRef<OsStr> for PathBuf[src]

impl AsRef<OsStr> for String[src]

impl AsRef<Path> for str[src]

impl AsRef<Path> for OsStr[src]

impl AsRef<Path> for OsString[src]

impl AsRef<Path> for Path[src]

impl AsRef<Path> for PathBuf[src]

impl AsRef<Path> for String[src]

impl<'_> AsRef<OsStr> for Component<'_>[src]

impl<'_> AsRef<OsStr> for Components<'_>[src]

impl<'_> AsRef<OsStr> for std::path::Iter<'_>[src]

impl<'_> AsRef<Path> for Cow<'_, OsStr>[src]

impl<'_> AsRef<Path> for Component<'_>[src]

impl<'_> AsRef<Path> for Components<'_>[src]

impl<'_> AsRef<Path> for std::path::Iter<'_>[src]

impl<'_, T> AsRef<[T]> for std::slice::Iter<'_, T>[src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<'_, T> AsRef<T> for Cow<'_, T> where
    T: ToOwned + ?Sized, [src]

ⓘImportant traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'_, R: Read + ?Sized> Read for &'_ mut R
impl<'_, W: Write + ?Sized> Write for &'_ mut W

impl<'_, T, U> AsRef<U> for &'_ T where
    T: AsRef<U> + ?Sized,
    U: ?Sized, [src]

ⓘImportant traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'_, R: Read + ?Sized> Read for &'_ mut R
impl<'_, W: Write + ?Sized> Write for &'_ mut W

impl<'_, T, U> AsRef<U> for &'_ mut T where
    T: AsRef<U> + ?Sized,
    U: ?Sized, [src]

ⓘImportant traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'_, R: Read + ?Sized> Read for &'_ mut R
impl<'_, W: Write + ?Sized> Write for &'_ mut W

impl<T> AsRef<[T]> for [T; 0][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 1][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 2][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 3][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 4][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 5][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 6][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 7][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 8][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 9][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 10][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 11][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 12][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 13][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 14][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 15][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 16][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 17][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 18][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 19][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 20][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 21][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 22][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 23][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 24][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 25][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 26][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 27][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 28][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 29][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 30][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 31][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T; 32][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for [T][src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<[T]> for Vec<T>[src]

ⓘImportant traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]

impl<T> AsRef<Vec<T>> for Vec<T>[src]

ⓘImportant traits for Vec<u8>
impl Write for Vec<u8>

impl<T> AsRef<T> for Box<T> where
    T: ?Sized, [src]

ⓘImportant traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'_, R: Read + ?Sized> Read for &'_ mut R
impl<'_, W: Write + ?Sized> Write for &'_ mut W

impl<T> AsRef<T> for Rc<T> where
    T: ?Sized, [src]

ⓘImportant traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'_, R: Read + ?Sized> Read for &'_ mut R
impl<'_, W: Write + ?Sized> Write for &'_ mut W

impl<T> AsRef<T> for Arc<T> where
    T: ?Sized, [src]

ⓘImportant traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'_, R: Read + ?Sized> Read for &'_ mut R
impl<'_, W: Write + ?Sized> Write for &'_ mut W
Loading content...

© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/convert/trait.AsRef.html