Struct LinkRule 

pub struct LinkRule { /* private fields */ }

Composable rule over links.

Implementations

impl LinkRule

pub const fn query(query: LinkQuery) -> Self

Wraps an existing structural query as a composable rule.

pub fn kind(kind: impl Into<String>) -> Self

Matches links by metadata term/kind.

pub const fn link_type(link_type: LinkType) -> Self

Matches links by link type.

pub fn capture(name: impl Into<String>, rule: Self) -> Self

Captures links selected by rule.

pub fn typed_metavariable( name: impl Into<String>, kind: impl Into<String>, ) -> Self

Captures links whose kind matches kind.

pub fn inside(rule: Self, ancestor: Self) -> Self

Matches rule only when selected links are inside ancestor.

pub fn has(rule: Self, descendant: Self) -> Self

Matches rule only when selected links contain a descendant.

pub fn precedes(rule: Self, following: Self) -> Self

Matches rule only when selected links precede following.

pub fn follows(rule: Self, preceding: Self) -> Self

Matches rule only when selected links follow preceding.

pub fn all(rules: impl Into<Vec<Self>>) -> Self

Intersects rules by selected link id.

pub fn any(rules: impl Into<Vec<Self>>) -> Self

Unions rules by selected link id.

pub fn negate(rule: Self) -> Self

Selects links not selected by rule.

pub fn named(name: impl Into<String>) -> Self

Refers to a named rule in a LinkRuleRegistry.

pub fn ellipsis_gap(before: Self, after: Self) -> Self

Matches a parent whose ordered children contain before ... after.

pub fn text(pattern: impl Into<String>) -> Result<Self, LinkRuleParseError>

Matches a full document’s plain source text with {{capture}} holes.

pub fn from_sexpression(source: &str) -> Result<Self, LinkRuleParseError>

Parses the documented rule-algebra S-expression surface.

pub fn matches( &self, network: &LinkNetwork, registry: &LinkRuleRegistry, ) -> Vec<LinkRuleMatch>

Returns matches for this rule using registry for named sub-rules.

Trait Implementations

impl Clone for LinkRule

fn clone(&self) -> LinkRule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LinkRule

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

Formats the value using the given formatter.

impl Not for LinkRule

type Output = LinkRule

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl PartialEq for LinkRule

fn eq(&self, other: &LinkRule) -> 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 LinkRule

impl StructuralPartialEq for LinkRule