Struct stam::TextSelection

pub struct TextSelection { /* private fields */ }

Corresponds to a slice of the text. This only contains minimal information; i.e. the begin offset, end offset and optionally a handle. if the textselection is already known in the model. This is similar to Offset, but that one uses cursors which may be relative. TextSelection specifies an offset in more absolute terms.

The actual reference to the crate::TextResource is not stored in this structure but should accompany it explicitly when needed, such as in the higher-level wrapper ResultTextSelection.

Implementations

impl TextSelection

pub fn begin(&self) -> usize

Return the begin position (unicode points)

pub fn end(&self) -> usize

Return the end position (non-inclusive) in unicode points

pub fn relative_begin(&self, container: &TextSelection) -> Option<usize>

Returns the begin cursor of this text selection in another. Returns None if they are not embedded. Note: this does NOT check whether the textselections pertain to the same resource, that is up to the caller.

pub fn relative_end(&self, container: &TextSelection) -> Option<usize>

Returns the end cursor (begin-aligned) of this text selection in another. Returns None if they are not embedded. Note: this does NOT check whether the textselections pertain to the same resource, that is up to the caller.

pub fn relative_offset( &self, container: &TextSelection, offsetmode: OffsetMode ) -> Option<Offset>

Returns the offset of this text selection in another. Returns None if they are not embedded. Note: this does NOT check whether the textselections pertain to the same resource, that is up to the caller.

pub fn absolute_offset(&self, offset: &Offset) -> Result<Offset, StamError>

Converts a relative offset, expressed in the coordinates of this text selection, to an absolute one expressed in the coordinates of the resource.

pub fn textselection_by_offset( &self, offset: &Offset ) -> Result<TextSelection, StamError>

Low-level method to get a textselection inside the current one Note: this is a low level method and will always return an unbound textselection!

pub fn to_resulttextselection<'store>( self, resource: &'store TextResource, store: &'store AnnotationStore ) -> ResultTextSelection<'store>

Convert this text selection to its higher level API counterpart

pub fn intersection( &self, other: &TextSelection ) -> Option<(TextSelection, Option<TextSelection>, Option<TextSelection>)>

Compute the intersection (overlap) between two text selections Returns the intersection part, self - other, other - self, as three new Text Selections. Returns none if there is no intersection at all. The text selections will not be bound to any handles.

If you merely want to test for overlap, then use test() instead.

Trait Implementations

impl Clone for TextSelection

fn clone(&self) -> TextSelection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl DataSize for TextSelection

const IS_DYNAMIC: bool = false

If true, the type has a heap size that can vary at runtime, depending on the actual value.

const STATIC_HEAP_SIZE: usize = 0usize

The amount of space a value of the type always occupies. If IS_DYNAMIC is false, this is the total amount of heap memory occupied by the value. Otherwise this is a lower bound.

fn estimate_heap_size(&self) -> usize

Estimates the size of heap memory taken up by this value.

impl Debug for TextSelection

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

Formats the value using the given formatter.

impl<'bytes, Ctx> Decode<'bytes, Ctx> for TextSelection

fn decode( __d777: &mut Decoder<'bytes>, __ctx777: &mut Ctx ) -> Result<TextSelection, Error>

Decode a value using the given Decoder.

fn nil() -> Option<Self>

If possible, return a nil value of Self.

impl<Ctx> Encode<Ctx> for TextSelection

fn encode<__W777>( &self, __e777: &mut Encoder<__W777>, __ctx777: &mut Ctx ) -> Result<(), Error<__W777::Error>>

where __W777: Write,

Encode a value of this type using the given Encoder.

fn is_nil(&self) -> bool

Is this value of Self a nil value?

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 From<&TextSelection> for Offset

fn from(textselection: &TextSelection) -> Offset

Converts to this type from the input type.

impl From<TextSelection> for Offset

fn from(textselection: TextSelection) -> Offset

Converts to this type from the input type.

impl Hash for TextSelection

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 TextSelection

fn cmp(&self, other: &Self) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for TextSelection

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

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<'a> Request<TextSelection> for TextSelectionHandle

fn to_handle<'store, S>(&self, _store: &'store S) -> Option<TextSelectionHandle>

where S: StoreFor<TextSelection>,

Returns the handle for this item, looking it up in the store

fn requested_id(&self) -> Option<&str>

If this type encapsulates an Id, this returns it (borrowed)

fn requested_id_owned(self) -> Option<String>

If this type encapsulates an Id, this returns it (oened)

fn requested_handle(&self) -> Option<T::HandleType>

If this type encapsulates a handle, this returns it

fn any(&self) -> bool

Represents a request for any value in certain contexts

impl Storable for TextSelection

type HandleType = TextSelectionHandle

type StoreHandleType = TextResourceHandle

type FullHandleType = (TextResourceHandle, TextSelectionHandle)

type StoreType = TextResource

fn id(&self) -> Option<&str>

Get the public identifier

fn handle(&self) -> Option<TextSelectionHandle>

Retrieve the internal (numeric) id. For any type T in StoreFor<T>, this may return None only in the initial stage when it is still unbounded to a store, so this is almost always safe to unwrap when used in the public API.

fn with_handle(self, handle: TextSelectionHandle) -> Self

Set the internal ID for an item. May only be called once just after instantiation. This is a low-level API method that can not be used publicly due to ownership restrictions.

fn carries_id() -> bool

Does this type support an ID?

fn fullhandle( storehandle: Self::StoreHandleType, handle: Self::HandleType ) -> Self::FullHandleType

fn merge(&mut self, _other: Self) -> Result<(), StamError>

Merge another item into this one This is a low-level API method, mostly for internal use.

fn unbind(self) -> Self

Unbind an item This is a low-level API method that can not be used publicly due to ownership restrictions.

fn handle_or_err(&self) -> Result<Self::HandleType, StamError>

Like Self::handle() but returns a StamError::Unbound error if there is no internal id.

fn temp_id(&self) -> Result<String, StamError>

Generate a temporary public ID based on the internal handle.

fn as_resultitem<'store>( &'store self, store: &'store Self::StoreType, rootstore: &'store AnnotationStore ) -> ResultItem<'store, Self>

where Self: Sized,

Returns the item of type T as a ResultItem<T>, i.e. a wrapped reference that includes a reference to both this item as well as the store that owns it. All high-level API functions are implemented on such Result types. You should not need to invoke this yourself.

fn generate_id(self, idmap: Option<&mut IdMap<Self::HandleType>>) -> Self

where Self: Sized,

Generate a random ID in a given idmap (adds it to the map and assigns it to the item) This is a low-level API method that can not be used publicly due to ownership restrictions.

fn with_id(self, id: impl Into<String>) -> Self

where Self: Sized,

Builder pattern to set the public ID

impl StoreFor<TextSelection> for TextResource

fn store(&self) -> &Store<TextSelection>

Get a reference to the entire store for the associated type

fn store_mut(&mut self) -> &mut Store<TextSelection>

Get a mutable reference to the entire store for the associated type

fn idmap(&self) -> Option<&IdMap<TextSelectionHandle>>

Get a reference to the id map for the associated type, mapping global ids to internal ids

fn idmap_mut(&mut self) -> Option<&mut IdMap<TextSelectionHandle>>

Get a mutable reference to the id map for the associated type, mapping global ids to internal ids

fn store_typeinfo() -> &'static str

fn insert(&mut self, item: T) -> Result<T::HandleType, StamError>

Adds an item to the store. Returns a handle to it upon success.

fn add(self, item: T) -> Result<Self, StamError>

where Self: Sized,

Inserts items into the store using a builder pattern

fn has(&self, item: impl Request<T>) -> bool

Returns true if the store has the item

unsafe fn get_unchecked(&self, handle: T::HandleType) -> Option<&T>

Get a reference to an item from the store, by handle, without checking validity.

fn get(&self, item: impl Request<T>) -> Result<&T, StamError>

Get a reference to an item from the store This is a low-level API method, you usually want to use dedicated high-level methods like AnnotationStore::annotation() instead.

fn get_mut(&mut self, item: impl Request<T>) -> Result<&mut T, StamError>

Get a mutable reference to an item from the store by internal ID This is a low-level API method

fn remove(&mut self, item: impl Request<T>) -> Result<(), StamError>

Removes an item

fn resolve_id(&self, id: &str) -> Result<T::HandleType, StamError>

Resolves an ID to a handle. Also works for temporary IDs if enabled. This is a low-level API method. You usually don’t want to call this directly.

fn iter(&self) -> StoreIter<'_, T>

where T: Storable<StoreType = Self>,

Iterate over all items in the store This is a low-level API method, use dedicated high-level iterators like annotations(), resources() instead.

fn iter_mut(&mut self) -> StoreIterMut<'_, T>

Iterate over the store, mutably This is a low-level API method.

fn next_handle(&self) -> T::HandleType

Return the internal id that will be assigned for the next item to the store This is a low-level API method.

fn last_handle(&self) -> T::HandleType

Return the internal id that was assigned to last inserted item This is a low-level API method.

impl TestTextSelection for TextSelection

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 a TextSelection and another. 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 a TextSelection and another (or multiple) (TextSelectionSet). The operator contains the other part of the equation that is tested against. A boolean is returned with the test result.

impl TypeInfo for TextSelection

fn typeinfo() -> Type

Return the type (introspection).

fn temp_id_prefix() -> &'static str

Return the prefix for temporary identifiers of this type

impl Copy for TextSelection

impl Eq for TextSelection

impl StructuralPartialEq for TextSelection