Skip to main content

BorrowedValue

rustpython_common::borrow

Enum BorrowedValue

pub enum BorrowedValue<'a, T: ?Sized> {
    Ref(&'a T),
    MuLock(PyMutexGuard<'a, T>),
    MappedMuLock(PyImmutableMappedMutexGuard<'a, T>),
    ReadLock(PyRwLockReadGuard<'a, T>),
    MappedReadLock(PyMappedRwLockReadGuard<'a, T>),
    MappedDetachingReadLock(PyMappedDetachingRwLockReadGuard<'a, T>),
}

Variants§

Ref(&'a T)

MuLock(PyMutexGuard<'a, T>)

MappedMuLock(PyImmutableMappedMutexGuard<'a, T>)

ReadLock(PyRwLockReadGuard<'a, T>)

MappedReadLock(PyMappedRwLockReadGuard<'a, T>)

MappedDetachingReadLock(PyMappedDetachingRwLockReadGuard<'a, T>)

Implementations§

impl<'a, T: ?Sized> BorrowedValue<'a, T>

pub const fn is_locked(&self) -> bool

Whether reaching the value holds a lock that other threads wait on.

An immutable object hands out a plain reference and answers false; one whose storage can change hands out a guard. A caller about to wait for something unrelated – a peer, a file, a signal – can use this to decide whether it may keep the borrow for the duration.

pub fn map<U: ?Sized, F>(s: Self, f: F) -> BorrowedValue<'a, U>
where F: FnOnce(&T) -> &U,

Trait Implementations§

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

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

Formats the value using the given formatter. Read more

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

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl Display for BorrowedValue<'_, str>

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

Formats the value using the given formatter. Read more

impl<'a, T: ?Sized> From<&'a T> for BorrowedValue<'a, T>

fn from(t: &'a T) -> Self

Converts to this type from the input type.

impl<'a, T: ?Sized> From<ImmutableMappedMutexGuard<'a, RawCellMutex, T>> for BorrowedValue<'a, T>

fn from(t: PyImmutableMappedMutexGuard<'a, T>) -> Self

Converts to this type from the input type.

impl<'a, T: ?Sized> From<MappedRwLockReadGuard<'a, RawCellRwLock, T>> for BorrowedValue<'a, T>

fn from(t: PyMappedRwLockReadGuard<'a, T>) -> Self

Converts to this type from the input type.

impl<'a, T: ?Sized> From<MappedRwLockReadGuard<'a, RawDetachingRwLock, T>> for BorrowedValue<'a, T>

fn from(t: PyMappedDetachingRwLockReadGuard<'a, T>) -> Self

Converts to this type from the input type.

impl<'a, T: ?Sized> From<MutexGuard<'a, RawCellMutex, T>> for BorrowedValue<'a, T>

fn from(t: PyMutexGuard<'a, T>) -> Self

Converts to this type from the input type.

impl<'a, T: ?Sized> From<RwLockReadGuard<'a, RawCellRwLock, T>> for BorrowedValue<'a, T>

fn from(t: PyRwLockReadGuard<'a, T>) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

impl<'a, T> !RefUnwindSafe for BorrowedValue<'a, T>

impl<'a, T> !Send for BorrowedValue<'a, T>

impl<'a, T> !Sync for BorrowedValue<'a, T>

impl<'a, T> !UnwindSafe for BorrowedValue<'a, T>

impl<'a, T> Freeze for BorrowedValue<'a, T>
where &'a T: Freeze, MutexGuard<'a, RawCellMutex, T>: Freeze, ImmutableMappedMutexGuard<'a, RawCellMutex, T>: Freeze, RwLockReadGuard<'a, RawCellRwLock, T>: Freeze, MappedRwLockReadGuard<'a, RawCellRwLock, T>: Freeze, MappedRwLockReadGuard<'a, RawDetachingRwLock, T>: Freeze, T: ?Sized,

impl<'a, T> Unpin for BorrowedValue<'a, T>
where &'a T: Unpin, MutexGuard<'a, RawCellMutex, T>: Unpin, ImmutableMappedMutexGuard<'a, RawCellMutex, T>: Unpin, RwLockReadGuard<'a, RawCellRwLock, T>: Unpin, MappedRwLockReadGuard<'a, RawCellRwLock, T>: Unpin, MappedRwLockReadGuard<'a, RawDetachingRwLock, T>: Unpin, T: ?Sized,

impl<'a, T> UnsafeUnpin for BorrowedValue<'a, T>
where &'a T: UnsafeUnpin, MutexGuard<'a, RawCellMutex, T>: UnsafeUnpin, ImmutableMappedMutexGuard<'a, RawCellMutex, T>: UnsafeUnpin, RwLockReadGuard<'a, RawCellRwLock, T>: UnsafeUnpin, MappedRwLockReadGuard<'a, RawCellRwLock, T>: UnsafeUnpin, MappedRwLockReadGuard<'a, RawDetachingRwLock, T>: UnsafeUnpin, T: ?Sized,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

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

Mutably borrows from an owned value. Read more

impl<T> ErasedDestructor for T
where T: 'static,

impl<T, U> ExactFrom<T> for U
where U: TryFrom<T>,

fn exact_from(value: T) -> U

impl<T, U> ExactInto<U> for T
where U: ExactFrom<T>,

fn exact_into(self) -> U

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> ImaginaryInto<U> for T
where U: ImaginaryFrom<T>,

fn imaginary_into(self) -> U

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T, U> OverflowingInto<U> for T
where U: OverflowingFrom<T>,

fn overflowing_into(self) -> (U, bool)

impl<T> PrimitiveIntRandomBounds for T

impl<T> PrimitiveSignedRandomBounds for T

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)

The target type on which the method may be called.

impl<T, U> RoundingInto<U> for T
where U: RoundingFrom<T>,

fn rounding_into(self, rm: RoundingMode) -> (U, Ordering)

impl<T, U> SaturatingInto<U> for T
where U: SaturatingFrom<T>,

fn saturating_into(self) -> U

impl<T> ToDebugString for T
where T: Debug,

fn to_debug_string(&self) -> String

Returns the String produced by Ts Debug implementation.

§Examples

use malachite_base::strings::ToDebugString;

assert_eq!([1, 2, 3].to_debug_string(), "[1, 2, 3]");
assert_eq!(
    [vec![2, 3], vec![], vec![4]].to_debug_string(),
    "[[2, 3], [], [4]]"
);
assert_eq!(Some(5).to_debug_string(), "Some(5)");

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T, U> WrappingInto<U> for T
where U: WrappingFrom<T>,

fn wrapping_into(self) -> U