Trait BorrowMut

pub trait BorrowMut<Borrowed>: Borrow<Borrowed>
where
    Borrowed: ?Sized,
{
    // Required method
    fn borrow_mut(&mut self) -> &mut Borrowed;
}

A trait for mutably borrowing data.

As a companion to Borrow<T> this trait allows a type to borrow as an underlying type by providing a mutable reference. See Borrow<T> for more information on borrowing as another type.

Required Methods

fn borrow_mut(&mut self) -> &mut Borrowed

Mutably borrows from an owned value.

Examples

use std::borrow::BorrowMut;

fn check<T: BorrowMut<[i32]>>(mut v: T) {
    assert_eq!(&mut [1, 2, 3], v.borrow_mut());
}

let v = vec![1, 2, 3];

check(v);

Implementors

impl BorrowMut<str> for String

impl<T> BorrowMut<T> for &mut T

where T: ?Sized,

impl<T> BorrowMut<T> for T

where T: ?Sized,

impl<T, A: Allocator> BorrowMut<[T]> for Vec<T, A>

impl<T, const N: usize> BorrowMut<[T]> for [T; N]

impl<T: ?Sized, A: Allocator> BorrowMut<T> for Box<T, A>