Struct stam::ResultTextSelectionSet

pub struct ResultTextSelectionSet<'store> { /* private fields */ }

A TextSelectionSet holds one or more TextSelection items and a reference to the TextResource from which they’re drawn. This structure encapsulates such a TextSelectionSet and contains a reference to the underlying AnnotationStore.

Implementations

impl<'store> ResultTextSelectionSet<'store>

pub fn rootstore(&self) -> &'store AnnotationStore

pub fn resource(&self) -> ResultItem<'store, TextResource>

pub fn related_text( self, operator: TextSelectionOperator ) -> impl Iterator<Item = ResultTextSelection<'store>>

Applies a TextSelectionOperator to find all other text selections that are in a specific relation with the current text selection set. Returns an iterator over the TextSelection instances. (as ResultItem<TextSelection>). If you are interested in the annotations associated with the found text selections, then use [Self::find_annotations()] instead.

pub fn test( &self, operator: &TextSelectionOperator, other: &ResultTextSelection<'_> ) -> bool

Compares whether a particular spatial relation holds between two text selections

pub fn test_set( &self, operator: &TextSelectionOperator, other: &ResultTextSelectionSet<'_> ) -> bool

Compares whether a particular spatial relation holds between this text selections and a set of others

impl<'store> ResultTextSelectionSet<'store>

pub fn inner(&self) -> &TextSelectionSet

pub fn len(&self) -> usize

pub fn iter<'a>( &'a self ) -> impl Iterator<Item = ResultTextSelection<'store>> + 'a

Trait Implementations

impl<'store> From<ResultTextSelectionSet<'store>> for TextSelectionSet

fn from(other: ResultTextSelectionSet<'store>) -> Self

Converts to this type from the input type.

impl<'store> FromIterator<ResultTextSelection<'store>> for ResultTextSelectionSet<'store>

fn from_iter<T: IntoIterator<Item = ResultTextSelection<'store>>>( iter: T ) -> Self

Creates a value from an iterator.

impl<'store> PartialEq for ResultTextSelectionSet<'store>

fn eq(&self, other: &Self) -> 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<'store> PartialOrd for ResultTextSelectionSet<'store>

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<'store> Transposable<'store> for ResultTextSelectionSet<'store>

fn transpose( &self, via: &ResultItem<'store, Annotation>, config: TransposeConfig ) -> Result<Vec<AnnotationBuilder<'static>>, StamError>

The transpose function maps an annotation, textselection, or textselection set from one coordinate system to another. These mappings are defined in annotations called transpositions and are documented here: https://github.com/annotation/stam/blob/master/extensions/stam-transpose/README.md Transpositions link identical textual parts across resources, any annotations within the bounds of such a mapping can then be transposed using this function to the other coordinate system.

impl<'store> TryFrom<&ResultItem<'store, Annotation>> for ResultTextSelectionSet<'store>

type Error = StamError

The type returned in the event of a conversion error.

fn try_from( annotation: &ResultItem<'store, Annotation> ) -> Result<Self, Self::Error>

Performs the conversion.