Trait nom::lib::std::prelude::v1::rust_2015::AsRef1.0.0[][src]

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

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

Performs the conversion.

Implementations on Foreign Types

Implementors

impl<A> AsRef<str> for ArrayString<A> where
    A: Array<Item = u8> + Copy

impl<A: Array> AsRef<[<A as Array>::Item]> for ArrayVec<A>

impl AsRef<Path> for Utf8Components<'_>

impl AsRef<str> for Utf8Components<'_>

impl AsRef<OsStr> for Utf8Components<'_>

impl AsRef<Utf8Path> for Iter<'_>

impl AsRef<Path> for Iter<'_>

impl AsRef<str> for Iter<'_>

impl AsRef<OsStr> for Iter<'_>

impl AsRef<Path> for Utf8Component<'_>

impl AsRef<str> for Utf8Component<'_>

impl AsRef<OsStr> for Utf8Component<'_>

impl AsRef<Utf8Path> for str

impl AsRef<Path> for Utf8Path

impl AsRef<str> for Utf8Path

impl AsRef<OsStr> for Utf8Path

impl AsRef<str> for Triple

impl AsRef<str> for Arch

impl AsRef<str> for Vendor

impl AsRef<str> for Os

impl AsRef<str> for Family

impl AsRef<str> for Env

impl<T: ?Sized + Pointable> AsRef<T> for Owned<T>

impl<T: ?Sized, Q: ?Sized> AsRef<Q> for DebugIgnore<T> where
    T: AsRef<Q>, 

impl<L, R, Target> AsRef<Target> for Either<L, R> where
    L: AsRef<Target>,
    R: AsRef<Target>, 

impl<L, R> AsRef<str> for Either<L, R> where
    L: AsRef<str>,
    R: AsRef<str>, 

impl<L, R, Target> AsRef<[Target]> for Either<L, R> where
    L: AsRef<[Target]>,
    R: AsRef<[Target]>, 

impl AsRef<dyn Error + Send + Sync + 'static> for Report

impl AsRef<dyn Error + 'static> for Report

impl AsRef<str> for Signal

impl AsRef<RawOsStr> for str

impl AsRef<str> for Output

impl<'a> AsRef<Event<'a>> for Event<'a>

impl AsRef<[u8]> for Literal

impl<A: Array> AsRef<[<A as Array>::Item]> for SmallVec<A>