Skip to main content

BufferGuard

Struct BufferGuard 

Source
pub struct BufferGuard<M: RawMutex + 'static, T> { /* private fields */ }
Expand description

Exclusive handle to one pooled T. Releasing the slot on Drop.

Derefs to T via Deref / DerefMut. Use BufferGuard::map to borrow a subfield or slice while keeping the same pool slot.

Implementations§

Source§

impl<M: RawMutex + 'static, T> BufferGuard<M, T>

Source

pub fn map<U: ?Sized>( orig: Self, fun: impl FnOnce(&mut T) -> &mut U, ) -> MappedBufferGuard<M, U>

Narrows the guard to a &mut U derived from the buffer (for example a slice into a larger [u8]). The original guard is consumed without running its Drop; the returned MappedBufferGuard still returns the pool slot when dropped.

This is an associated function, not a method: the guard is passed as orig, not self. You call it as BufferGuard::map(guard, f). If the first parameter were self, guard.map(...) would always resolve to this routine and shadow a map method on T; with orig: Self, guard.map(...) can still go through Deref / DerefMut to T::map when you want the inner value’s API.

Trait Implementations§

Source§

impl<M: RawMutex + 'static, T> Deref for BufferGuard<M, T>

Source§

type Target = T

The resulting type after dereferencing.
Source§

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

Dereferences the value.
Source§

impl<M: RawMutex + 'static, T> DerefMut for BufferGuard<M, T>

Source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.
Source§

impl<M: RawMutex + 'static, T> Drop for BufferGuard<M, T>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<M, T> Freeze for BufferGuard<M, T>

§

impl<M, T> !RefUnwindSafe for BufferGuard<M, T>

§

impl<M, T> Send for BufferGuard<M, T>
where M: Sync,

§

impl<M, T> Sync for BufferGuard<M, T>
where M: Sync,

§

impl<M, T> Unpin for BufferGuard<M, T>

§

impl<M, T> UnsafeUnpin for BufferGuard<M, T>

§

impl<M, T> !UnwindSafe for BufferGuard<M, T>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.