Skip to main content

StationSet

Struct StationSet 

Source
pub struct StationSet { /* private fields */ }
Expand description

Small ordered in-process Station collection for simulations and embedders.

Implementations§

Source§

impl StationSet

Source

pub fn with_capacity(capacity: usize) -> Self

Creates an empty collection with capacity for capacity Stations.

Source

pub fn reserve(&mut self, additional: usize)

Reserves capacity for at least additional more Stations and lookup entries.

Source

pub fn push(&mut self, station: Station)

Adds a station to the collection.

Source

pub fn remove(&mut self, station_id: StationId) -> Option<Station>

Removes and returns the first Station with station_id.

Remaining Stations retain their iteration order. Lookup storage remains allocated for reuse when the indexed path is active.

Source

pub fn get(&self, station_id: StationId) -> Option<&Station>

Gets a station by id.

Source

pub fn get_mut(&mut self, station_id: StationId) -> Option<&mut Station>

Gets a mutable station by id.

Source

pub fn get_pair_mut( &mut self, left_id: StationId, right_id: StationId, ) -> Option<(&mut Station, &mut Station)>

Gets two distinct mutable stations by id.

Source

pub fn iter(&self) -> impl Iterator<Item = &Station>

Iterates over stations.

Source

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut Station>

Iterates mutably over stations.

Source

pub fn station_ids_in_scope(&self, scope: BarrierScope) -> Vec<StationId>

Returns station ids matching a barrier scope.

Source

pub fn len(&self) -> usize

Number of stations.

Source

pub fn station_capacity(&self) -> usize

Station slots retained without growing the ordered collection.

Source

pub fn lookup_capacity(&self) -> usize

Lookup entries retained without rehashing the Station index.

Source

pub fn lookup_index_active(&self) -> bool

Returns whether Station lookup currently uses the indexed path.

Source

pub fn is_empty(&self) -> bool

Returns whether no stations are registered.

Trait Implementations§

Source§

impl Clone for StationSet

Source§

fn clone(&self) -> StationSet

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StationSet

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for StationSet

Source§

fn default() -> StationSet

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.