Trait libreda_db::layout::prelude::Deref

1.0.0 · source ·
pub trait Deref {
    type Target: ?Sized;

    // Required method
    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);

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 RcString

source§

impl Deref for CString

§

type Target = CStr

source§

impl Deref for alloc::string::String

§

type Target = str

source§

impl Deref for OsString

source§

impl Deref for PathBuf

§

type Target = Path

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>

§

impl<'a, R, G, T> Deref for MappedReentrantMutexGuard<'a, R, G, T>where R: RawMutex + 'a, G: GetThreadId + 'a, T: 'a + ?Sized,

§

type Target = T

§

impl<'a, R, G, T> Deref for ReentrantMutexGuard<'a, R, G, T>where R: RawMutex + 'a, G: GetThreadId + 'a, T: 'a + ?Sized,

§

type Target = T

§

impl<'a, R, T> Deref for MappedMutexGuard<'a, R, T>where R: RawMutex + 'a, T: 'a + ?Sized,

§

type Target = T

§

impl<'a, R, T> Deref for MappedRwLockReadGuard<'a, R, T>where R: RawRwLock + 'a, T: 'a + ?Sized,

§

type Target = T

§

impl<'a, R, T> Deref for MappedRwLockWriteGuard<'a, R, T>where R: RawRwLock + 'a, T: 'a + ?Sized,

§

type Target = T

§

impl<'a, R, T> Deref for MutexGuard<'a, R, T>where R: RawMutex + 'a, T: 'a + ?Sized,

§

type Target = T

§

impl<'a, R, T> Deref for RwLockReadGuard<'a, R, T>where R: RawRwLock + 'a, T: 'a + ?Sized,

§

type Target = T

§

impl<'a, R, T> Deref for RwLockUpgradableReadGuard<'a, R, T>where R: RawRwLockUpgrade + 'a, T: 'a + ?Sized,

§

type Target = T

§

impl<'a, R, T> Deref for RwLockWriteGuard<'a, R, T>where R: RawRwLock + 'a, T: 'a + ?Sized,

§

type Target = T

§

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

§

type Target = T

§

impl<'a, T> Deref for SpinMutexGuard<'a, T>where T: ?Sized,

§

type Target = T

source§

impl<'a, T, U> Deref for Undo<'a, T, U>

§

type Target = T

§

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

§

type Target = T

§

impl<'rwlock, T, R> Deref for RwLockUpgradableGuard<'rwlock, T, R>where T: ?Sized,

§

type Target = T

§

impl<'rwlock, T, R> Deref for RwLockWriteGuard<'rwlock, T, R>where T: ?Sized,

§

type Target = T

§

impl<A> Deref for SmallVec<A>where A: Array,

§

type Target = [<A as Array>::Item]

source§

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

§

type Target = B

source§

impl<L, R> Deref for Either<L, R>where L: Deref, R: Deref<Target = <L as Deref>::Target>,

§

type Target = <L as Deref>::Target

1.33.0 · source§

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

§

type Target = <P as Deref>::Target

§

impl<P> Deref for Arc<P>where P: Pool,

§

type Target = <P as Pool>::Data

§

impl<P> Deref for Box<P, Init>where P: Pool,

§

type Target = <P as Pool>::Data

const: unstable · source§

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

§

type Target = T

const: unstable · source§

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

§

type Target = T

§

impl<T> Deref for Point<T>

§

type Target = Vector<T>

source§

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

§

type Target = T

1.12.0 · source§

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

§

type Target = T

source§

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

§

type Target = T

source§

impl<T> Deref for alloc::sync::Arc<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.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 std::sync::mutex::MutexGuard<'_, T>where T: ?Sized,

§

type Target = T

source§

impl<T> Deref for std::sync::rwlock::RwLockReadGuard<'_, T>where T: ?Sized,

§

type Target = T

source§

impl<T> Deref for std::sync::rwlock::RwLockWriteGuard<'_, T>where T: ?Sized,

§

type Target = T

§

impl<T> Deref for Box<T, Init>

§

type Target = T

const: unstable · source§

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

§

type Target = T

source§

impl<T, A> Deref for alloc::vec::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> Deref for LazyLock<T, F>where F: FnOnce() -> T,

§

type Target = T

§

impl<T, F, R> Deref for Lazy<T, F, R>where F: FnOnce() -> T, R: RelaxStrategy,

§

type Target = T

source§

impl<T, F, S> Deref for ScopeGuard<T, F, S>where F: FnOnce(T), S: Strategy,

§

type Target = T

§

impl<T, Idx, K, const N: usize> Deref for FindMut<'_, T, Idx, K, N>where T: Ord, Idx: SortedLinkedListIndex, K: Kind,

§

type Target = T

§

impl<T, K, const N: usize> Deref for PeekMut<'_, T, K, N>where T: Ord, K: Kind,

§

type Target = T

§

impl<T, S> Deref for Text<T, S>where S: Deref<Target = String>,

§

impl<T, const N: usize> Deref for HistoryBuffer<T, N>

§

type Target = [T]

§

impl<T, const N: usize> Deref for Vec<T, N>

§

type Target = [T]

§

impl<const N: usize> Deref for String<N>

§

type Target = str