Struct LinkTable

pub struct LinkTable<K> { /* private fields */ }

Table for tracking links between ports.

Two ports are connected when they share the same link. Links are named and scoped via closed regions. Links from one closed region are not visible in another. Open regions are considered to form the same scope as their parent region. Links do not have a unique point of declaration.

The link table keeps track of an association between a key of type K and the link indices within each closed region. When resolving links from a text format, K is the name of the link as a string slice. However the link table might is also useful in other contexts where the key is not a string when constructing a module from a different representation.

Examples

let mut links = LinkTable::new();
links.enter(RegionId(0));
let foo_0 = links.use_link("foo");
let bar_0 = links.use_link("bar");
assert_eq!(foo_0, links.use_link("foo"));
assert_eq!(bar_0, links.use_link("bar"));
let (num_links, num_ports) = links.exit();
assert_eq!(num_links, 2);
assert_eq!(num_ports, 4);

Implementations

impl<K> LinkTable<K>

where K: Copy + Eq + Hash,

pub fn new() -> Self

Create a new empty link table.

pub fn enter(&mut self, region: RegionId)

Enter a new scope for the given closed region.

pub fn exit(&mut self) -> (u32, u32)

Exit a previously entered scope, returning the number of links and ports in the scope.

pub fn use_link(&mut self, key: K) -> LinkIndex

Resolve a link key to a link index, adding one more port to the current scope.

If the key has not been used in the current scope before, it will be added to the link table.

Panics

Panics if there are no open scopes.

pub fn clear(&mut self)

Reset the link table to an empty state while preserving allocated memory.

Trait Implementations

impl<K: Clone> Clone for LinkTable<K>

fn clone(&self) -> LinkTable<K>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K: Debug> Debug for LinkTable<K>

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

Formats the value using the given formatter.

impl<K> Default for LinkTable<K>

where K: Copy + Eq + Hash,

fn default() -> Self

Returns the “default value” for a type.