Skip to main content

IndexRef

Enum IndexRef 

Source
pub enum IndexRef<'idx> {
    Direct(&'idx mut Index),
    Shared(Rc<RefCell<Index>>),
}
Expand description

A mutable index reference used by crate::Stream.

This enum abstracts over two index ownership patterns:

  • Direct(&mut Index): the stream owns an exclusive mutable borrow of the index.
  • Shared(Rc<RefCell<Index>>): the stream borrows the index through runtime-checked interior mutability, allowing aliasing within a single thread.

Use Direct when the stream is the only owner of the index. Use Shared when the same index must be accessed from multiple aliasing locations.

Variants§

§

Direct(&'idx mut Index)

§

Shared(Rc<RefCell<Index>>)

Implementations§

Source§

impl<'idx> IndexRef<'idx>

Source

pub fn get(&self) -> Guard<'_>

Get a read-only view of the underlying index.

For Shared, this performs a RefCell::borrow and will panic if a mutable borrow is already active.

Source

pub fn get_mut(&mut self) -> MutGuard<'_>

Get a mutable view of the underlying index.

For Shared, this performs a RefCell::borrow_mut and will panic if any other borrow is active.

Trait Implementations§

Source§

impl<'idx> Debug for IndexRef<'idx>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'idx> !RefUnwindSafe for IndexRef<'idx>

§

impl<'idx> !Send for IndexRef<'idx>

§

impl<'idx> !Sync for IndexRef<'idx>

§

impl<'idx> !UnwindSafe for IndexRef<'idx>

§

impl<'idx> Freeze for IndexRef<'idx>

§

impl<'idx> Unpin for IndexRef<'idx>

§

impl<'idx> UnsafeUnpin for IndexRef<'idx>

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<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.