Primitive Type reference

References, both shared and mutable.

A reference represents a borrow of some owned value. You can get one by using the & or &mut operators on a value, or by using a ref or ref mut pattern.

For those familiar with pointers, a reference is just a pointer that is assumed to be aligned, not null, and pointing to memory containing a valid value of T - for example, &bool can only point to an allocation containing the integer values 1 (true) or 0 (false), but creating a &bool that points to an allocation containing the value 3 causes undefined behaviour. In fact, Option<&T> has the same memory representation as a nullable but aligned pointer, and can be passed across FFI boundaries as such.

In most cases, references can be used much like the original value. Field access, method calling, and indexing work the same (save for mutability rules, of course). In addition, the comparison operators transparently defer to the referent’s implementation, allowing references to be compared the same as owned values.

References have a lifetime attached to them, which represents the scope for which the borrow is valid. A lifetime is said to “outlive” another one if its representative scope is as long or longer than the other. The 'static lifetime is the longest lifetime, which represents the total life of the program. For example, string literals have a 'static lifetime because the text data is embedded into the binary of the program, rather than in an allocation that needs to be dynamically managed.

&mut T references can be freely coerced into &T references with the same referent type, and references with longer lifetimes can be freely coerced into references with shorter ones.

Reference equality by address, instead of comparing the values pointed to, is accomplished via implicit reference-pointer coercion and raw pointer equality via ptr::eq, while PartialEq compares values.

use std::ptr;

let five = 5;
let other_five = 5;
let five_ref = &five;
let same_five_ref = &five;
let other_five_ref = &other_five;

assert!(five_ref == same_five_ref);
assert!(five_ref == other_five_ref);

assert!(ptr::eq(five_ref, same_five_ref));
assert!(!ptr::eq(five_ref, other_five_ref));

For more information on how to use references, see the book’s section on “References and Borrowing”.

Trait implementations

The following traits are implemented for all &T, regardless of the type of its referent:

• Copy
• Clone (Note that this will not defer to T’s Clone implementation if it exists!)
• Deref
• Borrow
• fmt::Pointer

&mut T references get all of the above except Copy and Clone (to prevent creating multiple simultaneous mutable borrows), plus the following, regardless of the type of its referent:

• DerefMut
• BorrowMut

The following traits are implemented on &T references if the underlying T also implements that trait:

• All the traits in std::fmt except fmt::Pointer (which is implemented regardless of the type of its referent) and fmt::Write
• PartialOrd
• Ord
• PartialEq
• Eq
• AsRef
• Fn (in addition, &T references get FnMut and FnOnce if T: Fn)
• Hash
• ToSocketAddrs
• Send (&T references also require T: Sync)

&mut T references get all of the above except ToSocketAddrs, plus the following, if T implements that trait:

• AsMut
• FnMut (in addition, &mut T references get FnOnce if T: FnMut)
• fmt::Write
• Iterator
• DoubleEndedIterator
• ExactSizeIterator
• FusedIterator
• TrustedLen
• io::Write
• Read
• Seek
• BufRead

Note that due to method call deref coercion, simply calling a trait method will act like they work on references as well as they do on owned values! The implementations described here are meant for generic contexts, where the final type T is a type parameter or otherwise not locally known.

Implementations

impl<'a, T> Pin<&'a T> where
    T: ?Sized, 

pub unsafe fn map_unchecked<U, F>(self, func: F) -> Pin<&'a U> where
    F: FnOnce(&T) -> &U,
    U: ?Sized, 

Constructs a new pin by mapping the interior value.

For example, if you wanted to get a Pin of a field of something, you could use this to get access to that field in one line of code. However, there are several gotchas with these “pinning projections”; see the pin module documentation for further details on that topic.

Safety

This function is unsafe. You must guarantee that the data you return will not move so long as the argument value does not move (for example, because it is one of the fields of that value), and also that you do not move out of the argument you receive to the interior function.

pub fn get_ref(self) -> &'a T

Gets a shared reference out of a pin.

This is safe because it is not possible to move out of a shared reference. It may seem like there is an issue here with interior mutability: in fact, it is possible to move a T out of a &RefCell<T>. However, this is not a problem as long as there does not also exist a Pin<&T> pointing to the same data, and RefCell<T> does not let you create a pinned reference to its contents. See the discussion on “pinning projections” for further details.

Note: Pin also implements Deref to the target, which can be used to access the inner value. However, Deref only provides a reference that lives for as long as the borrow of the Pin, not the lifetime of the Pin itself. This method allows turning the Pin into a reference with the same lifetime as the original Pin.

impl<'a, T> Pin<&'a mut T> where
    T: ?Sized, 

pub fn into_ref(self) -> Pin<&'a T>

Converts this Pin<&mut T> into a Pin<&T> with the same lifetime.

pub fn get_mut(self) -> &'a mut T where
    T: Unpin, 

Gets a mutable reference to the data inside of this Pin.

This requires that the data inside this Pin is Unpin.

Note: Pin also implements DerefMut to the data, which can be used to access the inner value. However, DerefMut only provides a reference that lives for as long as the borrow of the Pin, not the lifetime of the Pin itself. This method allows turning the Pin into a reference with the same lifetime as the original Pin.

pub unsafe fn get_unchecked_mut(self) -> &'a mut T

Gets a mutable reference to the data inside of this Pin.

Safety

This function is unsafe. You must guarantee that you will never move the data out of the mutable reference you receive when you call this function, so that the invariants on the Pin type can be upheld.

If the underlying data is Unpin, Pin::get_mut should be used instead.

pub unsafe fn map_unchecked_mut<U, F>(self, func: F) -> Pin<&'a mut U> where
    F: FnOnce(&mut T) -> &mut U,
    U: ?Sized, 

Construct a new pin by mapping the interior value.

For example, if you wanted to get a Pin of a field of something, you could use this to get access to that field in one line of code. However, there are several gotchas with these “pinning projections”; see the pin module documentation for further details on that topic.

Safety

This function is unsafe. You must guarantee that the data you return will not move so long as the argument value does not move (for example, because it is one of the fields of that value), and also that you do not move out of the argument you receive to the interior function.

impl<T> Pin<&'static T> where
    T: ?Sized, 

pub fn static_ref(r: &'static T) -> Pin<&'static T>

Get a pinned reference from a static reference.

This is safe, because T is borrowed for the 'static lifetime, which never ends.

impl<T> Pin<&'static mut T> where
    T: ?Sized, 

pub fn static_mut(r: &'static mut T) -> Pin<&'static mut T>

Get a pinned mutable reference from a static mutable reference.

This is safe, because T is borrowed for the 'static lifetime, which never ends.

Trait Implementations

impl<'a, T, A> Extend<&'a T> for BTreeSet<T, A> where
    T: 'a + Ord + Copy,
    A: Allocator + Clone, 

fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = &'a T>, 

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, &'a T)

🔬 This is a nightly-only experimental API. (extend_one #72631)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one #72631)

Reserves capacity in a collection for the given number of additional elements.

impl<'a, T> Extend<&'a T> for LinkedList<T> where
    T: 'a + Copy, 

fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = &'a T>, 

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, &'a T)

🔬 This is a nightly-only experimental API. (extend_one #72631)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one #72631)

Reserves capacity in a collection for the given number of additional elements.

impl<'a, T> Extend<&'a T> for BinaryHeap<T> where
    T: 'a + Ord + Copy, 

fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = &'a T>, 

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, &'a T)

🔬 This is a nightly-only experimental API. (extend_one #72631)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one #72631)

Reserves capacity in a collection for the given number of additional elements.

impl<'a, T, A> Extend<&'a T> for Vec<T, A> where
    T: 'a + Copy,
    A: 'a + Allocator, 

Extend implementation that copies elements out of references before pushing them onto the Vec.

This implementation is specialized for slice iterators, where it uses copy_from_slice to append the entire slice at once.

fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = &'a T>, 

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, &'a T)

🔬 This is a nightly-only experimental API. (extend_one #72631)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one #72631)

Reserves capacity in a collection for the given number of additional elements.

impl<'a, T, A> Extend<&'a T> for VecDeque<T, A> where
    T: 'a + Copy,
    A: Allocator, 

fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = &'a T>, 

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, &T)

🔬 This is a nightly-only experimental API. (extend_one #72631)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one #72631)

Reserves capacity in a collection for the given number of additional elements.

impl<'a, T, S> Extend<&'a T> for HashSet<T, S> where
    T: 'a + Eq + Hash + Copy,
    S: BuildHasher, 

fn extend<I: IntoIterator<Item = &'a T>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: &'a T)

🔬 This is a nightly-only experimental API. (extend_one #72631)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one #72631)

Reserves capacity in a collection for the given number of additional elements.

impl<'_, T> From<&T> for NonNull<T> where
    T: ?Sized, 

fn from(reference: &T) -> NonNull<T>

Converts a &T to a NonNull<T>.

This conversion is safe and infallible since references cannot be null.

impl<T: ?Sized + AsRef<OsStr>> From<&T> for OsString

fn from(s: &T) -> OsString

Copies any value implementing AsRef<OsStr> into a newly allocated OsString.

impl<T: ?Sized + AsRef<OsStr>> From<&T> for PathBuf

fn from(s: &T) -> PathBuf

Converts a borrowed OsStr to a PathBuf.

Allocates a PathBuf and copies the data into it.

impl<'_, T> From<&mut T> for NonNull<T> where
    T: ?Sized, 

fn from(reference: &mut T) -> NonNull<T>

Converts a &mut T to a NonNull<T>.

This conversion is safe and infallible since references cannot be null.

impl<'_, G, R> Generator<R> for Pin<&mut G> where
    G: Generator<R> + ?Sized, 

type Yield = <G as Generator<R>>::Yield

🔬 This is a nightly-only experimental API. (generator_trait #43122)

The type of value this generator yields.

type Return = <G as Generator<R>>::Return

🔬 This is a nightly-only experimental API. (generator_trait #43122)

The type of value this generator returns.

fn resume(
    self: Pin<&mut Pin<&mut G>>,
    arg: R
) -> GeneratorState<<Pin<&mut G> as Generator<R>>::Yield, <Pin<&mut G> as Generator<R>>::Return>

🔬 This is a nightly-only experimental API. (generator_trait #43122)

Resumes the execution of this generator.

impl<'_, K, Q, V, A> Index<&Q> for BTreeMap<K, V, A> where
    A: Allocator + Clone,
    K: Borrow<Q> + Ord,
    Q: Ord + ?Sized, 

fn index(&self, key: &Q) -> &V

Returns a reference to the value corresponding to the supplied key.

Panics

Panics if the key is not present in the BTreeMap.

type Output = V

The returned type after indexing.

impl<K, Q: ?Sized, V, S> Index<&Q> for HashMap<K, V, S> where
    K: Eq + Hash + Borrow<Q>,
    Q: Eq + Hash,
    S: BuildHasher, 

fn index(&self, key: &Q) -> &V

Returns a reference to the value corresponding to the supplied key.

Panics

Panics if the key is not present in the HashMap.

type Output = V

The returned type after indexing.

impl<'_, T, V> Join<&T> for [V] where
    T: Clone,
    V: Borrow<[T]>, 

type Output = Vec<T, Global>

🔬 This is a nightly-only experimental API. (slice_concat_trait #27747)

The resulting type after concatenation

fn join(slice: &[V], sep: &T) -> Vec<T, Global>

🔬 This is a nightly-only experimental API. (slice_concat_trait #27747)

Implementation of [T]::join

impl<'_, '_, A, B> PartialEq<&B> for &A where
    A: PartialEq<B> + ?Sized,
    B: ?Sized, 

fn eq(&self, other: &&B) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &&B) -> bool

This method tests for !=.

impl<'_, '_, A, B> PartialEq<&B> for &mut A where
    A: PartialEq<B> + ?Sized,
    B: ?Sized, 

fn eq(&self, other: &&B) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &&B) -> bool

This method tests for !=.

impl<'_, '_, A, B> PartialEq<&mut B> for &mut A where
    A: PartialEq<B> + ?Sized,
    B: ?Sized, 

fn eq(&self, other: &&mut B) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &&mut B) -> bool

This method tests for !=.

impl<'_, '_, A, B> PartialEq<&mut B> for &A where
    A: PartialEq<B> + ?Sized,
    B: ?Sized, 

fn eq(&self, other: &&mut B) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &&mut B) -> bool

This method tests for !=.

impl<'_, '_, A, B> PartialOrd<&B> for &A where
    A: PartialOrd<B> + ?Sized,
    B: ?Sized, 

fn partial_cmp(&self, other: &&B) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &&B) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &&B) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &&B) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &&B) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'_, '_, A, B> PartialOrd<&mut B> for &mut A where
    A: PartialOrd<B> + ?Sized,
    B: ?Sized, 

fn partial_cmp(&self, other: &&mut B) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &&mut B) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &&mut B) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &&mut B) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &&mut B) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a, 'b, T, U> CoerceUnsized<&'a U> for &'b mut T where
    'b: 'a,
    T: Unsize<U> + ?Sized,
    U: ?Sized, 

impl<'a, 'b, T, U> CoerceUnsized<&'a U> for &'b T where
    'b: 'a,
    T: Unsize<U> + ?Sized,
    U: ?Sized, 

impl<'a, T, U> CoerceUnsized<&'a mut U> for &'a mut T where
    T: Unsize<U> + ?Sized,
    U: ?Sized, 

impl<'a, T, U> DispatchFromDyn<&'a U> for &'a T where
    T: Unsize<U> + ?Sized,
    U: ?Sized, 

impl<'a, T, U> DispatchFromDyn<&'a mut U> for &'a mut T where
    T: Unsize<U> + ?Sized,
    U: ?Sized,