Entry

Enum Entry 

Source
pub enum Entry<'a, I, T, SA: Allocator = Global, DA: Allocator = Global> {
    Vacant(VacantEntry<'a, I, T, SA, DA>),
    Occupied(OccupiedEntry<'a, I, T, SA, DA>),
}
Expand description

A view into a single entry in a sparse set, which may be either vacant or occupied.

This is constructed from the SparseSet::entry function.

Variants§

§

Vacant(VacantEntry<'a, I, T, SA, DA>)

A vacant entry.

§

Occupied(OccupiedEntry<'a, I, T, SA, DA>)

An occupied entry.

Implementations§

Source§

impl<'a, I: SparseSetIndex, T, SA: Allocator, DA: Allocator> Entry<'a, I, T, SA, DA>

Source

pub fn and_modify<F: FnOnce(&mut T)>(self, function: F) -> Self

Provides in-place mutable access to an occupied entry before any potential inserts into the sparse set.

Source

pub fn entry_index(&self) -> I

The index used to create this entry.

Source

pub fn or_insert(self, default: T) -> &'a mut T

Ensures a value is in the entry by inserting the default if empty, and returns a mutable reference to the value in the entry.

Source

pub fn or_insert_with<F: FnOnce() -> T>(self, default: F) -> &'a mut T

Ensures a value is in the entry by inserting the result of the default function if empty, and returns a mutable reference to the value in the entry.

Source

pub fn insert_entry(self, value: T) -> OccupiedEntry<'a, I, T, SA, DA>

Sets the value of the entry, and returns an OccupiedEntry.

Trait Implementations§

Source§

impl<I: Debug + SparseSetIndex, T: Debug, SA: Allocator, DA: Allocator> Debug for Entry<'_, I, T, SA, DA>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, I, T, SA, DA> Freeze for Entry<'a, I, T, SA, DA>
where I: Freeze,

§

impl<'a, I, T, SA, DA> RefUnwindSafe for Entry<'a, I, T, SA, DA>

§

impl<'a, I, T, SA, DA> Send for Entry<'a, I, T, SA, DA>
where I: Send, DA: Send, T: Send, SA: Send,

§

impl<'a, I, T, SA, DA> Sync for Entry<'a, I, T, SA, DA>
where I: Sync, DA: Sync, T: Sync, SA: Sync,

§

impl<'a, I, T, SA, DA> Unpin for Entry<'a, I, T, SA, DA>
where I: Unpin,

§

impl<'a, I, T, SA = Global, DA = Global> !UnwindSafe for Entry<'a, I, T, SA, DA>

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.