Struct CtxQuery

pub struct CtxQuery<'a, S: Element, F: Fn(&S) -> bool> { /* private fields */ }

A context query builder. Initiate a query via CompositionContext::find.

Implementations

impl<'a, S: Element, F: Fn(&S) -> bool> CtxQuery<'a, S, F>

pub fn with_timing<R: RangeBounds<i32>>( self, relation: TimingRelation, timing: R, ) -> Self

Restrict the search to segments matching a given TimingRelation.

pub fn within<S2: Element>(self) -> Self

Restrict the search to descendent segments a given Element type. This does not in itself impose any timing constraints for the search – for that, use with_timing.

pub fn within_ancestor<S2: Element>(self) -> Self

Restrict the search to segments generated within the initiator’s ancestor of the given Element. This does not in itself impose any timing constraints for the search – for that, use with_timing.

pub fn matching( self, where_fn: impl Fn(&S) -> bool, ) -> CtxQuery<'a, S, impl Fn(&S) -> bool>

Restrict the search to segments matching the supplied closure.

pub fn get(self) -> Option<SegmentRef<'a, S>>

Runs the context query, and returns a single optional result, or None if none are found.

pub fn get_all(self) -> Option<Vec<SegmentRef<'a, S>>>

Runs the context query, and returns all results, or None if none are found.

pub fn get_at_least( self, min_requested: usize, ) -> Option<Vec<SegmentRef<'a, S>>>

Runs the context query. Returns all results if at least min_requested results are found, otherwise None is returned.

pub fn require(self) -> Result<SegmentRef<'a, S>>

Runs the context query, and returns a single result, or MissingContext error if none are found.

pub fn require_all(self) -> Result<Vec<SegmentRef<'a, S>>>

Runs the context query, and returns all results, or MissingContext error if none are found.

pub fn require_at_least( self, min_requested: usize, ) -> Result<Vec<SegmentRef<'a, S>>>

Runs the context query. If at least min_requested results are found they are returned, otherwise a MissingContext error is returned.

Trait Implementations

impl<'a, S: Debug + Element, F: Debug + Fn(&S) -> bool> Debug for CtxQuery<'a, S, F>

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

Formats the value using the given formatter.