Enum stam::TextSelectionOperator

pub enum TextSelectionOperator {
    Equals {
        all: bool,
        negate: bool,
    },
    Overlaps {
        all: bool,
        negate: bool,
    },
    Embeds {
        all: bool,
        negate: bool,
    },
    Embedded {
        all: bool,
        negate: bool,
        limit: Option<usize>,
    },
    Before {
        all: bool,
        negate: bool,
        limit: Option<usize>,
    },
    After {
        all: bool,
        negate: bool,
        limit: Option<usize>,
    },
    Precedes {
        all: bool,
        negate: bool,
        allow_whitespace: bool,
    },
    Succeeds {
        all: bool,
        negate: bool,
        allow_whitespace: bool,
    },
    SameBegin {
        all: bool,
        negate: bool,
    },
    SameEnd {
        all: bool,
        negate: bool,
    },
    InSet {
        all: bool,
        negate: bool,
    },
    SameRange {
        all: bool,
        negate: bool,
    },
}

The TextSelectionOperator, simply put, allows comparison of two TextSelection instances. It allows testing for all kinds of spatial relations (as embodied by this enum) in which two TextSelection instances can be, such as overlap, embedding, adjacency, etc…

Rather than operator on single TextSelection instances, the implementation goes a bit further and can act also on the basis of TextSelectionSet rather than TextSelection, allowing you to compare two sets, each containing possibly multiple TextSelections, at once.

Use the various methods on this type to quickly instantiate a variant.

Variants

Equals

Both sets cover the exact same TextSelections, and all are covered (cf. textfabric’s ==), commutative, transitive

Fields

all: bool

negate: bool

Overlaps

All items in both sets must cover the exact same TextSelection. This would be fairly useless, it just means both sets contain only one TextSelection and it’s the same one Each TextSelection in A overlaps with a TextSelection in B (cf. textfabric’s &&), commutative If modifier all is set: Each TextSelection in A overlaps with all TextSelection in B (cf. textfabric’s &&), commutative

Fields

all: bool

negate: bool

Embeds

All TextSelections in B are embedded by a TextSelection in A (cf. textfabric’s [[) If modifier all is set: All TextSelections in B are embedded by all TextSelection in A (cf. textfabric’s [[)

Fields

all: bool

negate: bool

Embedded

All TextSelections in A are embedded by a TextSelection in B (cf. textfabric’s ]]) If modifier all is set: All TextSelections in A are embedded by all TextSelection in B (cf. textfabric’s ]]) The limit, if set, constrains the lookup range (in unicode points), which can positively affect performance

Fields

all: bool

negate: bool

limit: Option<usize>

Before

Each TextSelections in A comes before a textselection in B If modifier all is set: All TextSelections in A precede (come before) all textselections in B. There is no overlap (cf. textfabric’s <<) The limit, if set, constrains the lookup range (in unicode points), which can positively affect performance

Fields

all: bool

negate: bool

limit: Option<usize>

After

Each TextSeleciton In A succeeds (comes after) a textselection in B If modifier all is set: All TextSelections in A succeed (come after) all textselections in B. There is no overlap (cf. textfabric’s >>) The limit, if set, constrains the lookup range (in unicode points), which can positively affect performance

Fields

all: bool

negate: bool

limit: Option<usize>

Precedes

Each TextSelection in A ends where at least one TextSelection in B begins. If modifier all is set: The rightmost TextSelections in A end where the leftmost TextSelection in B begins (cf. textfabric’s <:) If modifier allow_whitespace is set, a limited amount of whitespace is allowed between the two text selections

Fields

all: bool

negate: bool

allow_whitespace: bool

Succeeds

Each TextSelection in A begis where at least one TextSelection in A ends. If modifier all is set: The leftmost TextSelection in A starts where the rightmost TextSelection in B ends (cf. textfabric’s :>) If modifier allow_whitespace is set, a limited amount of whitespace is allowed between the two text selections

Fields

all: bool

negate: bool

allow_whitespace: bool

SameBegin

Each TextSelection in A starts where a TextSelection in B starts If modifier all is set: The leftmost TextSelection in A starts where the leftmost TextSelection in B start (cf. textfabric’s =:)

Fields

all: bool

negate: bool

SameEnd

Each TextSelection in A ends where a TextSelection in B ends If modifier all is set: The rightmost TextSelection in A ends where the rights TextSelection in B ends (cf. textfabric’s :=)

Fields

all: bool

negate: bool

InSet

Each TextSelection in A is in B as well, this is similar to Equals but allows for set B having unmatched items

Fields

all: bool

negate: bool

SameRange

The leftmost TextSelection in A starts where the leftmost TextSelection in A starts and the rightmost TextSelection in A ends where the rights TextSelection in B ends (cf. textfabric’s ::)

Fields

all: bool

negate: bool

Implementations

impl TextSelectionOperator

pub fn all(&self) -> bool

pub fn as_str(&self) -> &'static str

pub fn equals() -> Self

pub fn overlaps() -> Self

pub fn embeds() -> Self

pub fn embedded() -> Self

pub fn before() -> Self

pub fn after() -> Self

pub fn precedes() -> Self

This operator allows whitespace between the two text selections

pub fn precedes_exact() -> Self

This operator does not allow whitespace between the two text selections

pub fn succeeds() -> Self

This operator allows whitespace between the two text selections

pub fn succeeds_exact() -> Self

This operator does not allow whitespace between the two text selections

pub fn samebegin() -> Self

pub fn sameend() -> Self

pub fn samerange() -> Self

pub fn inset() -> Self

pub fn with_limit(self, limit: usize) -> Self

Constrains the operator to a limit range (in unicode points)

pub fn toggle_negate(&self) -> Self

pub fn toggle_all(&self) -> Self

Trait Implementations

impl Clone for TextSelectionOperator

fn clone(&self) -> TextSelectionOperator

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextSelectionOperator

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

Formats the value using the given formatter.

impl PartialEq for TextSelectionOperator

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for TextSelectionOperator

impl StructuralPartialEq for TextSelectionOperator