Struct StreamMatch

pub struct StreamMatch {
    pub id: ExpressionIndex,
    pub range: Range,
}

Available on crate feature stream only.

Match objects returned when searching streaming data.

This is returned by e.g. Scratch::scan_sync_stream(), Scratch::scan_sync_vectored_stream(), or Scratch::flush_eod_sync().

Fields

id: ExpressionIndex

ID of matched expression, or 0 if unspecified.

range: Range

The start (if Flags::SOM_LEFTMOST is provided) and end offsets of the match, with reference to the entire history of string data that has been provided to this LiveStream object.

Note that LiveStream::reset() will reset the stream automaton to its start state and cause match offsets reported to the callback after the reset to start once again from 0.

See the crate::stream module for a further discussion of how and when to effectively use the streaming interface, especially how to work around not being able to reference the contents of the original data stream.

Trait Implementations

impl Clone for StreamMatch

fn clone(&self) -> StreamMatch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamMatch

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

Formats the value using the given formatter.

impl Hash for StreamMatch

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for StreamMatch

fn cmp(&self, other: &StreamMatch) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for StreamMatch

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

fn partial_cmp(&self, other: &StreamMatch) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for StreamMatch

impl Eq for StreamMatch

impl StructuralPartialEq for StreamMatch