Struct SelRegion

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

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§

Source§

impl SelRegion

Source

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

Returns a new region.

Source

pub fn caret(pos: usize) -> Self

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

Source

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

Returns a region with the given horizontal position.

Source

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

Returns a region with the given affinity.

Source

pub fn min(self) -> usize

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

Source

pub fn max(self) -> usize

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

Source

pub fn is_caret(self) -> bool

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

Source

pub fn is_upstream(self) -> bool

Determines whether the region’s affinity is upstream.

Trait Implementations§

Source§

impl Clone for SelRegion

Source§

fn clone(&self) -> SelRegion

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SelRegion

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for SelRegion

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Converts to this type from the input type.
Source§

impl From<Interval> for SelRegion

Source§

fn from(src: Interval) -> SelRegion

Converts to this type from the input type.
Source§

impl From<SelRegion> for Selection

Source§

fn from(region: SelRegion) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for SelRegion

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for SelRegion

Source§

impl Eq for SelRegion

Source§

impl StructuralPartialEq for SelRegion

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.