Struct Selection 

pub struct Selection {
    pub begin: Place,
    pub end: Place,
}

A selection: an anchor and an active end, in that order, unordered by value.

use pdfrum_form::edit::{Place, Selection};

let lo = Place::new(0, 0, Some(1));
let hi = Place::new(0, 0, Some(5));
let forwards = Selection::new(lo, hi);
let backwards = Selection::new(hi, lo);

// The direction is kept, so the two are not equal.
assert!(!forwards.is_backwards());
assert!(backwards.is_backwards());
assert_ne!(forwards, backwards);
// They still cover the same text.
assert_eq!(forwards.range(), backwards.range());

Fields

begin: Place

The fixed end.

end: Place

The end that moves with the caret.

Implementations

impl Selection

pub fn empty() -> Selection

A collapsed selection at the start of the text.

use pdfrum_form::edit::{Place, PlaceExt, Selection};

assert!(Selection::empty().is_empty());
assert_eq!(Selection::empty().begin, Place::start());
// An anchor at the start is still an anchor, so this is no reset.
assert!(!Selection::empty().is_reset());

pub fn new(begin: Place, end: Place) -> Selection

A selection anchored at begin, active at end.

use pdfrum_form::edit::{Place, Selection};

let sel = Selection::new(Place::new(0, 0, Some(7)), Place::new(0, 0, Some(2)));
// Nothing orders the two on the way in: this one runs backwards.
assert!(sel.is_backwards());
assert_eq!(sel.range().begin(), Place::new(0, 0, Some(2)));

pub fn collapsed_at(place: Place) -> Selection

A live anchor at one place, selecting nothing.

What a mutation or a mouse-down leaves behind, and what a following shift-move extends from.

use pdfrum_form::edit::{Place, Selection};

let here = Place::new(0, 0, Some(3));
let sel = Selection::collapsed_at(here);
assert!(sel.is_empty());
assert!(!sel.is_reset(), "the anchor is live");
assert_eq!(sel.begin, here);

pub fn reset() -> Selection

No selection and no anchor.

Distinct from a collapsed selection: a shift-move from here anchors on the caret’s previous position rather than on this one.

use pdfrum_form::edit::{Place, Selection};

assert!(Selection::reset().is_reset());
assert_ne!(
    Selection::reset(),
    Selection::collapsed_at(Place::new(0, 0, Some(3)))
);

pub fn is_empty(self) -> bool

Whether the selection covers no text.

Says nothing about whether an anchor exists; see Selection::is_reset.

use pdfrum_form::edit::{Place, Selection};

let here = Place::new(0, 0, Some(3));
assert!(Selection::collapsed_at(here).is_empty());
assert!(!Selection::new(here, Place::new(0, 0, Some(5))).is_empty());

pub fn is_reset(self) -> bool

Whether the selection has no anchor at all.

use pdfrum_form::edit::{Place, Selection};

assert!(Selection::reset().is_reset());
assert!(!Selection::collapsed_at(Place::new(0, 0, Some(3))).is_reset());

pub fn is_backwards(self) -> bool

Whether the active end lies before the anchor.

use pdfrum_form::edit::{Place, Selection};

let lo = Place::new(0, 0, Some(1));
let hi = Place::new(0, 0, Some(5));
assert!(Selection::new(hi, lo).is_backwards());
assert!(!Selection::new(lo, hi).is_backwards());

pub fn range(self) -> Range

The span, ordered. Direction is discarded here and nowhere else.

use pdfrum_form::edit::{Place, Selection};

let sel = Selection::new(Place::new(0, 0, Some(7)), Place::new(0, 0, Some(2)));
assert!(sel.range().begin() <= sel.range().end());
assert_eq!(sel.range().begin(), Place::new(0, 0, Some(2)));

pub fn set_active(&mut self, place: Place)

Moves the active end, keeping the anchor. What a shift-move does once an anchor exists.

use pdfrum_form::edit::{Place, Selection};

let anchor = Place::new(0, 0, Some(1));
let mut sel = Selection::collapsed_at(anchor);
sel.set_active(Place::new(0, 0, Some(4)));

assert_eq!(sel.begin, anchor, "the anchor stays put");
assert_eq!(sel.end, Place::new(0, 0, Some(4)));
assert!(!sel.is_empty());

Trait Implementations

impl Clone for Selection

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Selection

impl Debug for Selection

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

Formats the value using the given formatter.

impl Default for Selection

fn default() -> Selection

Returns the “default value” for a type.

impl Eq for Selection

impl PartialEq for Selection

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Selection