Trait std::ops::Deref

1.0.0 · source ·

pub trait Deref {
 type Target: ?Sized;
 fn deref(&self) -> &Self::Target;
}

Expand description

Used for immutable dereferencing operations, like *v.

In addition to being used for explicit dereferencing operations with the (unary) * operator in immutable contexts, Deref is also used implicitly by the compiler in many circumstances. This mechanism is called ‘Deref coercion’. In mutable contexts, DerefMut is used.

Implementing Deref for smart pointers makes accessing the data behind them convenient, which is why they implement Deref. On the other hand, the rules regarding Deref and DerefMut were designed specifically to accommodate smart pointers. Because of this, Deref should only be implemented for smart pointers to avoid confusion.

For similar reasons, this trait should never fail. Failure during dereferencing can be extremely confusing when Deref is invoked implicitly.

More on Deref coercion

If T implements Deref<Target = U>, and x is a value of type T, then:

• In immutable contexts, *x (where T is neither a reference nor a raw pointer) is equivalent to *Deref::deref(&x).
• Values of type &T are coerced to values of type &U
• T implicitly implements all the (immutable) methods of the type U.

For more details, visit the chapter in The Rust Programming Language as well as the reference sections on the dereference operator, method resolution and type coercions.

Examples

A struct with a single field which is accessible by dereferencing the struct.

use std::ops::Deref;
struct DerefExample<T> {
 value: T
}
impl<T> Deref for DerefExample<T> {
 type Target = T;
 fn deref(&self) -> &Self::Target {
 &self.value
 }
}
let x = DerefExample { value: 'a' };
assert_eq!('a', *x);

Run

Required Associated Types

source

type Target: ?Sized

The resulting type after dereferencing.

Required Methods

source

fn deref(&self) -> &Self::Target

Dereferences the value.

Implementors

source

impl Deref for CString

type Target = CStr

source

impl Deref for OsString

type Target = OsStr

source

impl Deref for PathBuf

type Target = Path

source

impl Deref for String

type Target = str

1.36.0 · source

impl<'a> Deref for IoSlice<'a>

type Target = [u8]

1.36.0 · source

impl<'a> Deref for IoSliceMut<'a>

type Target = [u8]

source

impl<'a, 'f> Deref for VaList<'a, 'f> where
'f: 'a,

type Target = VaListImpl<'f>

const: unstable · source

impl<B> Deref for Cow<'_, B> where
B: ToOwned + ?Sized,
<B as ToOwned>::Owned: Borrow<B>,

type Target = B

1.33.0 · source

impl<P> Deref for Pin<P> where
P: Deref,

type Target = <P as Deref>::Target

const: unstable · source

impl<T> Deref for &T where
T: ?Sized,

type Target = T

const: unstable · source

impl<T> Deref for &mut T where
T: ?Sized,

type Target = T

source

impl<T> Deref for ThinBox<T> where
T: ?Sized,

type Target = T

source

impl<T> Deref for Ref<'_, T> where
T: ?Sized,

type Target = T

source

impl<T> Deref for RefMut<'_, T> where
T: ?Sized,

type Target = T

1.12.0 · source

impl<T> Deref for PeekMut<'_, T> where
T: Ord,

type Target = T

1.20.0 (const: unstable) · source

impl<T> Deref for ManuallyDrop<T> where
T: ?Sized,

type Target = T

1.9.0 · source

impl<T> Deref for AssertUnwindSafe<T>

type Target = T

source

impl<T> Deref for Rc<T> where
T: ?Sized,

type Target = T

source

impl<T> Deref for Arc<T> where
T: ?Sized,

type Target = T

const: unstable · source

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

type Target = T

source

impl<T, A> Deref for Vec<T, A> where
A: Allocator,

type Target = [T]

source

impl<T, F> Deref for LazyCell<T, F> where
F: FnOnce() -> T,

type Target = T

source

impl<T, F: FnOnce() -> T> Deref for LazyLock<T, F>

type Target = T

source

impl<T: ?Sized> Deref for MutexGuard<'_, T>

type Target = T

source

impl<T: ?Sized> Deref for RwLockReadGuard<'_, T>

type Target = T

source

impl<T: ?Sized> Deref for RwLockWriteGuard<'_, T>

type Target = T