Struct stam::TextSelectionSet

pub struct TextSelectionSet { /* private fields */ }

A TextSelectionSet holds one or more TextSelection items and a reference to the TextResource from which they’re drawn. All textselections in a set must reference the same resource, which implies they are comparable.

Implementations

impl TextSelectionSet

pub fn new(resource: TextResourceHandle) -> Self

pub fn as_resultset(self, store: &AnnotationStore) -> ResultTextSelectionSet<'_>

pub fn add(&mut self, textselection: TextSelection) -> &mut Self

pub fn iter<'a>(&'a self) -> TextSelectionSetIter<'a>

Iterate over the text selections

pub fn has_handle(&self, handle: TextSelectionHandle) -> bool

pub fn get(&self, index: usize) -> Option<&TextSelection>

pub fn len(&self) -> usize

pub fn resource(&self) -> TextResourceHandle

pub fn is_empty(&self) -> bool

pub fn begin(&self) -> Option<usize>

pub fn end(&self) -> Option<usize>

pub fn leftmost(&self) -> Option<&TextSelection>

Returns the left-most TextSelection (the one with the lowest start offset) in the set.

pub fn rightmost(&self) -> Option<&TextSelection>

Returns the right-most TextSelection (the one with the highest end offset) in the set.

pub fn sort(&mut self)

Sorts the TextSelections in this set in canonical text order. This needs to be done only once. Once the set is sorted, future inserts will retain the order (and therefore be slower)

Trait Implementations

impl Clone for TextSelectionSet

fn clone(&self) -> TextSelectionSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextSelectionSet

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

Formats the value using the given formatter.

impl Extend<TextSelection> for TextSelectionSet

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = TextSelection>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'store> From<ResultItem<'store, TextSelection>> for TextSelectionSet

fn from(textselection: ResultItem<'store, TextSelection>) -> Self

Converts to this type from the input type.

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

fn from(textselection: ResultTextSelection<'store>) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<'store> FromIterator<ResultItem<'store, TextSelection>> for TextSelectionSet

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

Creates a value from an iterator.

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

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

Creates a value from an iterator.

impl IntoIterator for TextSelectionSet

type Item = TextSelection

The type of the elements being iterated over.

type IntoIter = TextSelectionSetIntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for TextSelectionSet

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

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 TestTextSelection for TextSelectionSet

fn test( &self, operator: &TextSelectionOperator, reftextsel: &TextSelection, resource: &TextResource ) -> bool

This method is called to test whether a specific spatial relation (as expressed by the passed operator) holds between two TextSelectionSets. A boolean is returned with the test result.

fn test_set( &self, operator: &TextSelectionOperator, refset: &TextSelectionSet, resource: &TextResource ) -> bool

This method is called to test whether a specific spatial relation (as expressed by the passed operator) holds between two TextSelectionSets. A boolean is returned with the test result.

impl TypeInfo for TextSelectionSet

fn typeinfo() -> Type

Return the type (introspection).

fn temp_id_prefix() -> &'static str

Return the prefix for temporary identifiers of this type

impl StructuralPartialEq for TextSelectionSet