Struct ReadApiWrapper

pub struct ReadApiWrapper<'a, T: ?Sized>(pub &'a T);

ReadApi wrapper for constant references.

Example

use read_write_api::{ReadApi, ReadApiWrapper};
use parking_lot::RwLock;

fn read<T: ReadApi>(x: &T) -> T::ReadGuard<'_> {
    x.read()
}

let _ = read(&ReadApiWrapper(&1));
let _ = read(&RwLock::new(2));

Tuple Fields

0: &'a T

Wrapped reference.

Trait Implementations

impl<'a, T: Clone + ?Sized> Clone for ReadApiWrapper<'a, T>

fn clone(&self) -> ReadApiWrapper<'a, T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, T: Debug + ?Sized> Debug for ReadApiWrapper<'a, T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a, T: ?Sized> GuardedTarget for &ReadApiWrapper<'a, T>

type Target = &'a T

Dereferencing target of the read and write guards.

impl<'a, T: ?Sized> GuardedTarget for &mut ReadApiWrapper<'a, T>

type Target = &'a T

Dereferencing target of the read and write guards.

impl<'a, T: ?Sized> GuardedTarget for ReadApiWrapper<'a, T>

type Target = &'a T

Dereferencing target of the read and write guards.

impl<'a, T: Hash + ?Sized> Hash for ReadApiWrapper<'a, T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a, T: Ord + ?Sized> Ord for ReadApiWrapper<'a, T>

fn cmp(&self, other: &ReadApiWrapper<'a, T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a, T: PartialEq + ?Sized> PartialEq for ReadApiWrapper<'a, T>

fn eq(&self, other: &ReadApiWrapper<'a, T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, T: PartialOrd + ?Sized> PartialOrd for ReadApiWrapper<'a, T>

fn partial_cmp(&self, other: &ReadApiWrapper<'a, T>) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a, T: ?Sized> ReadApi for &ReadApiWrapper<'a, T>

type ReadGuard<'i> = &'i &'a T where Self: 'i

Self::read return type.

fn read(&self) -> &&'a T

Generalizes RwLock::read.

impl<'a, T: ?Sized> ReadApi for &mut ReadApiWrapper<'a, T>

type ReadGuard<'i> = &'i &'a T where Self: 'i

Self::read return type.

fn read(&self) -> &&'a T

Generalizes RwLock::read.

impl<'a, T: ?Sized> ReadApi for ReadApiWrapper<'a, T>

type ReadGuard<'i> = &'i &'a T where Self: 'i

Self::read return type.

fn read(&self) -> &&'a T

Generalizes RwLock::read.

impl<'a, T: Copy + ?Sized> Copy for ReadApiWrapper<'a, T>

impl<'a, T: Eq + ?Sized> Eq for ReadApiWrapper<'a, T>

impl<'a, T: ?Sized> StructuralPartialEq for ReadApiWrapper<'a, T>