Struct SelRegion

pub struct SelRegion {
    pub start: usize,
    pub end: usize,
    pub horiz: Option<HorizPos>,
    pub affinity: Affinity,
}

A type representing a single contiguous region of a selection. We use the term “caret” (sometimes also “cursor”, more loosely) to refer to a selection region with an empty interior. A “non-caret region” is one with a non-empty interior (i.e. start != end).

Fields

start: usize

The inactive edge of a selection, as a byte offset. When equal to end, the selection range acts as a caret.

end: usize

The active edge of a selection, as a byte offset.

horiz: Option<HorizPos>

A saved horizontal position (used primarily for line up/down movement).

affinity: Affinity

The affinity of the cursor.

Implementations

impl SelRegion

pub fn new(start: usize, end: usize) -> Self

Returns a new region.

pub fn caret(pos: usize) -> Self

Returns a new caret region (start == end).

pub fn with_horiz(self, horiz: Option<HorizPos>) -> Self

Returns a region with the given horizontal position.

pub fn with_affinity(self, affinity: Affinity) -> Self

Returns a region with the given affinity.

pub fn min(self) -> usize

Gets the earliest offset within the region, ie the minimum of both edges.

pub fn max(self) -> usize

Gets the latest offset within the region, ie the maximum of both edges.

pub fn is_caret(self) -> bool

Determines whether the region is a caret (ie has an empty interior).

pub fn is_upstream(self) -> bool

Determines whether the region’s affinity is upstream.

Trait Implementations

impl Clone for SelRegion

fn clone(&self) -> SelRegion

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SelRegion

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

Formats the value using the given formatter.

impl Display for SelRegion

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

Formats the value using the given formatter.

impl<'a> From<&'a SelRegion> for Interval

fn from(src: &'a SelRegion) -> Interval

Converts to this type from the input type.

impl From<Interval> for SelRegion

fn from(src: Interval) -> SelRegion

Converts to this type from the input type.

impl From<SelRegion> for Selection

fn from(region: SelRegion) -> Self

Converts to this type from the input type.

impl PartialEq for SelRegion

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

impl Eq for SelRegion

impl StructuralPartialEq for SelRegion