Struct dag::nameset::NameSet

pub struct NameSet(_);

A NameSet contains an immutable list of names.

It provides order-preserving iteration and set operations, and is cheaply clonable.

Implementations

impl NameSet

pub fn empty() -> Self

Creates an empty set.

pub fn from_static_names(names: impl IntoIterator<Item = VertexName>) -> NameSet

Creates from a (short) list of known names.

pub fn from_iter<I>(iter: I, hints: Hints) -> NameSetwhere
    I: IntoIterator<Item = Result<VertexName>> + 'static,
    <I as IntoIterator>::IntoIter: Send + Sync,

Creates from a (lazy) iterator of names.

pub fn from_stream(stream: BoxVertexStream, hints: Hints) -> NameSet

Creates from a (lazy) stream of names with hints.

pub fn from_id_iter_idmap_dag<I>(
    iter: I,
    map: Arc<dyn IdConvert + Send + Sync>,
    dag: Arc<dyn DagAlgorithm + Send + Sync>
) -> NameSetwhere
    I: IntoIterator<Item = Result<Id>> + 'static,
    <I as IntoIterator>::IntoIter: Send + Sync,

Creates from a (lazy) iterator of Ids, an IdMap, and a Dag.

pub fn from_id_iter_dag<I>(
    iter: I,
    dag: &impl DagAlgorithm + IdMapSnapshot
) -> Result<NameSet>where
    I: IntoIterator<Item = Result<Id>> + 'static,
    <I as IntoIterator>::IntoIter: Send + Sync,

Creates from a (lazy) iterator of Ids and a struct with snapshot abilities.

pub fn from_spans_idmap_dag(
    spans: IdSet,
    map: Arc<dyn IdConvert + Send + Sync>,
    dag: Arc<dyn DagAlgorithm + Send + Sync>
) -> NameSet

Creates from IdSet, [IdMap] and DagAlgorithm.

pub fn from_spans_dag(
    spans: IdSet,
    dag: &impl DagAlgorithm + IdMapSnapshot
) -> Result<Self>

Creates from IdSet and a struct with snapshot abilities.

pub fn from_evaluate_contains<C>(
    evaluate: impl Fn() -> Result<NameSet> + Send + Sync + 'static,
    contains: C,
    hints: Hints
) -> NameSetwhere
    C: for<'a> Fn(&'a MetaSet, &'a VertexName) -> Result<bool> + Send + Sync + 'static,

Creates from a function that evaluates to a NameSet, and a contains fast path.

pub fn from_async_evaluate_contains(
    evaluate: Box<dyn Fn() -> BoxFuture<'static, Result<NameSet>> + Send + Sync>,
    contains: Box<dyn for<'a> Fn(&'a MetaSet, &'a VertexName) -> BoxFuture<'a, Result<bool>> + Send + Sync>,
    hints: Hints
) -> NameSet

Creates from an async function that evaluates to a NameSet, and a async contains fast path.

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

Calculates the subset that is only in self, not in other.

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

Calculates the intersection of two sets.

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

Calculates the union of two sets.

pub fn filter(
    &self,
    filter_func: Box<dyn Fn(&VertexName) -> BoxFuture<'_, Result<bool>> + Send + Sync + 'static>
) -> Self

Filter using the given async function. If filter_func returns true for a vertex, then the vertex will be taken, other it will be skipped.

pub async fn to_parents(&self) -> Result<Option<impl Parents>>

Convert the set to a graph containing only the vertexes in the set. This can be slow on larger sets.

pub fn dag(&self) -> Option<Arc<dyn DagAlgorithm + Send + Sync>>

Obtain the attached dag if available.

pub fn id_map(&self) -> Option<Arc<dyn IdConvert + Send + Sync>>

Obtain the attached IdMap if available.

pub async fn flatten(&self) -> Result<NameSet>

Convert the current set into a flat static set so it can be used in some fast paths. This is useful for some common sets like obsolete() that might be represented by a complex expression.

pub async fn flatten_id(
    &self,
    id_map: Arc<dyn IdConvert + Send + Sync>,
    dag: Arc<dyn DagAlgorithm + Send + Sync>
) -> Result<NameSet>

Convert this set to a static id set.

pub async fn flatten_names(&self) -> Result<NameSet>

Convert this set to a static name set.

pub fn take(&self, n: u64) -> NameSet

Take the first n items.

pub fn skip(&self, n: u64) -> NameSet

Skip the first n items.

pub fn to_id_set_and_id_map_in_o1(
    &self
) -> Option<(IdSet, Arc<dyn IdConvert + Send + Sync>)>

Converts to (IdSet, IdConvert) pair in O(1). If the underlying set cannot provide such information in O(1), return None.

Useful if the callsite wants to have random access (ex. bisect) and control how to resolve in batches.

Trait Implementations

impl BitAnd<NameSet> for NameSet

type Output = NameSet

The resulting type after applying the & operator.

fn bitand(self, other: Self) -> Self

Performs the & operation.

impl BitOr<NameSet> for NameSet

type Output = NameSet

The resulting type after applying the | operator.

fn bitor(self, other: Self) -> Self

Performs the | operation.

impl Clone for NameSet

fn clone(&self) -> NameSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NameSet

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

Formats the value using the given formatter.

impl Deref for NameSet

type Target = dyn AsyncNameSetQuery + 'static

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<&VertexName> for NameSet

fn from(name: &VertexName) -> NameSet

Converts to this type from the input type.

impl<'a> From<(LegacyCodeNeedIdAccess, SpanSet, &'a AbstractNameDag<IdDag<IndexedLogStore>, IdMap, IndexedLogNameDagPath, NameDagState>)> for NameSet

fn from(value: (LegacyCodeNeedIdAccess, IdSet, &'a NameDag)) -> NameSet

Converts to this type from the input type.

impl From<VertexName> for NameSet

fn from(name: VertexName) -> NameSet

Converts to this type from the input type.

impl Sub<NameSet> for NameSet

type Output = NameSet

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self

Performs the - operation.

impl SyncNameSetQuery for NameSet

fn iter(&self) -> Result<Box<dyn NameIter>>

Iterate through the set in defined order.

fn iter_rev(&self) -> Result<Box<dyn NameIter>>

Iterate through the set in the reversed order.

fn count(&self) -> Result<usize>

Number of names in this set.

fn first(&self) -> Result<Option<VertexName>>

The first name in the set.

fn last(&self) -> Result<Option<VertexName>>

The last name in the set.

fn is_empty(&self) -> Result<bool>

Test if this set is empty.

fn contains(&self, name: &VertexName) -> Result<bool>

Test if this set contains a given name.

fn as_any(&self) -> &dyn Any

For downcasting.

fn hints(&self) -> &Hints

Get or set optimization hints.

fn id_convert(&self) -> Option<&dyn IdConvert>

Get an optional IdConvert interface to check hints.