Struct calyx_ir::IdList

pub struct IdList<T: GetName>(_);

A wrapper struct exposing an ordered collection of named entities within an RRC with deterministic iteration and constant-time look-up on names directly. The struct assumes that the name of an entity cannot change. Doing so will introduce incorrect results for look-ups.

Implementations

impl<T: GetName> IdList<T>

pub fn clear(&mut self)

Removes all elements from the collection

pub fn is_empty(&self) -> bool

Returns true if there are no elements in the list.

pub fn len(&self) -> usize

pub fn retain<F>(&mut self, f: F) -> u64where F: FnMut(&RRC<T>) -> bool,

Keep only the elements in the collection which satisfy the given predicate and return the number of elements removed.

pub fn add(&mut self, item: RRC<T>)

Add a new element to the colleciton

pub fn remove<S>(&mut self, name: S) -> Option<RRC<T>>where S: Into<Id>,

pub fn append(&mut self, items: impl Iterator<Item = RRC<T>>)

Add all elements to the collection

pub fn iter(&self) -> impl Clone + Iterator<Item = &RRC<T>>

Returns an iterator over immutable references

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

Returns an iterator over mutable references. Likely a pointless method as this is a collection of RRCs.

pub fn drain(&mut self) -> impl Iterator<Item = RRC<T>>

Removes all elements from the collection and returns an iterator over the owned elements.

pub fn find<S>(&self, name: S) -> Option<RRC<T>>where S: Into<Id>,

Returns the element indicated by the name, if present, otherwise None.

Trait Implementations

impl<T: Debug + GetName> Debug for IdList<T>

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

Formats the value using the given formatter.

impl<T: GetName> Default for IdList<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T, F> From<F> for IdList<T>where T: GetName, F: IntoIterator<Item = RRC<T>>,

fn from(list: F) -> Self

Converts to this type from the input type.

impl<'a, T: GetName> IntoIterator for &'a IdList<T>

Simple into-iter impl delegating to the Values.

type Item = &'a Rc<RefCell<T>>

The type of the elements being iterated over.

type IntoIter = Values<'a, Id, Rc<RefCell<T>>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.