Struct FieldSet 

pub struct FieldSet { /* private fields */ }

A set of field IDs implemented as a dynamically-sized bitset.

Used by propagators to declare which fields they read and write, enabling the engine to validate the dependency graph and compute overlay resolution plans.

Examples

use murk_core::{FieldSet, FieldId};

let mut set = FieldSet::empty();
set.insert(FieldId(0));
set.insert(FieldId(3));
assert!(set.contains(FieldId(0)));
assert!(!set.contains(FieldId(1)));

// Collect all IDs.
let ids: Vec<_> = set.iter().collect();
assert_eq!(ids, vec![FieldId(0), FieldId(3)]);

Implementations

impl FieldSet

pub fn empty() -> Self

Create an empty field set.

pub fn insert(&mut self, field: FieldId)

Insert a field ID into the set.

pub fn contains(&self, field: FieldId) -> bool

Check whether the set contains a field ID.

pub fn union(&self, other: &Self) -> Self

Return the union of two sets (self | other).

Examples

use murk_core::{FieldSet, FieldId};

let a: FieldSet = [FieldId(0), FieldId(1)].into_iter().collect();
let b: FieldSet = [FieldId(1), FieldId(2)].into_iter().collect();
let u = a.union(&b);
assert_eq!(u.len(), 3);
assert!(u.contains(FieldId(0)));
assert!(u.contains(FieldId(1)));
assert!(u.contains(FieldId(2)));

pub fn intersection(&self, other: &Self) -> Self

Return the intersection of two sets (self & other).

Examples

use murk_core::{FieldSet, FieldId};

let a: FieldSet = [FieldId(0), FieldId(1)].into_iter().collect();
let b: FieldSet = [FieldId(1), FieldId(2)].into_iter().collect();
let inter = a.intersection(&b);
assert_eq!(inter.len(), 1);
assert!(inter.contains(FieldId(1)));

pub fn difference(&self, other: &Self) -> Self

Return the set difference (self - other): elements in self but not other.

Examples

use murk_core::{FieldSet, FieldId};

let a: FieldSet = [FieldId(0), FieldId(1), FieldId(2)].into_iter().collect();
let b: FieldSet = [FieldId(1)].into_iter().collect();
let diff = a.difference(&b);
assert_eq!(diff.len(), 2);
assert!(diff.contains(FieldId(0)));
assert!(!diff.contains(FieldId(1)));
assert!(diff.contains(FieldId(2)));

pub fn is_subset(&self, other: &Self) -> bool

Check whether self is a subset of other.

pub fn is_empty(&self) -> bool

Returns true if the set contains no fields.

pub fn len(&self) -> usize

Returns the number of fields in the set.

pub fn iter(&self) -> FieldSetIter<'_>

Iterate over the field IDs in the set, in ascending order.

Trait Implementations

impl Clone for FieldSet

fn clone(&self) -> FieldSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldSet

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

Formats the value using the given formatter.

impl FromIterator<FieldId> for FieldSet

fn from_iter<I: IntoIterator<Item = FieldId>>(iter: I) -> Self

Creates a value from an iterator.

impl<'a> IntoIterator for &'a FieldSet

type Item = FieldId

The type of the elements being iterated over.

type IntoIter = FieldSetIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for FieldSet

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for FieldSet