Struct SelectionAnchor 

pub struct SelectionAnchor {
    pub place: Option<SelectionPlace>,
    pub items: Vec<SelectionPlace>,
    pub interaction: Option<InteractionAnchor>,
    pub excerpt: Option<String>,
}

What was selected: where (a place, an app-native anchor, or both) and a short excerpt of it. Every part is optional; an empty anchor says nothing and is dropped by Self::non_empty.

Encoded as a JSON object in JSON, and as that object’s JSON text in a binary format, because an InteractionAnchor reads only from JSON.

Fields

place: Option<SelectionPlace>

items: Vec<SelectionPlace>

Every item of a selection of several (files in a folder, rows of a list), each the whole of one item, in the order shown. Empty for a selection inside one item, which Self::place names.

interaction: Option<InteractionAnchor>

excerpt: Option<String>

Implementations

impl SelectionAnchor

pub fn of_text(excerpt: &str) -> SelectionAnchor

An anchor of excerpt alone: what is known of a selection in an app that publishes no resources, read from the primary selection.

pub fn of_items<I, L>( items: impl IntoIterator<Item = (I, L)>, ) -> SelectionAnchor

where I: Into<String>, L: AsRef<str>,

A selection of several whole items, each (id, label) in the order shown: every item named as a place (at most MAX_SELECTED_ITEMS), and an excerpt listing their labels, counting any beyond that.

pub fn with_excerpt(self, excerpt: &str) -> SelectionAnchor

pub fn at(self, place: SelectionPlace) -> SelectionAnchor

pub fn spanning( self, region: &str, ranges: Vec<InteractionTextRange>, ) -> SelectionAnchor

The same anchor noting the whole of a selection that spans several blocks of a text, ranges in document order, of which Self::place is one block’s part (an action’s place names one block). One range says nothing more than the place, so it is left out; a long selection keeps its first crate::interaction::MAX_ANCHOR_ITEMS.

pub fn spanned_ranges(&self) -> Option<&[InteractionTextRange]>

The block ranges of a selection spanning several blocks (Self::spanning).

pub fn is_empty(&self) -> bool

Whether the anchor says nothing at all.

pub fn non_empty(self) -> Option<SelectionAnchor>

The anchor, unless it says nothing.

pub fn validate(&self) -> Result<(), String>

Whether the anchor is within bounds, so a receiver may keep it.

Trait Implementations

impl Clone for SelectionAnchor

fn clone(&self) -> SelectionAnchor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SelectionAnchor

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

Formats the value using the given formatter.

impl Default for SelectionAnchor

fn default() -> SelectionAnchor

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SelectionAnchor

fn deserialize<D>( deserializer: D, ) -> Result<SelectionAnchor, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SelectionAnchor

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

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SelectionAnchor

impl StructuralPartialEq for SelectionAnchor