Struct TerminalSelection

Source
pub struct TerminalSelection {
    pub anchor: TerminalPosition,
    pub focus: TerminalPosition,
}
Expand description

Direction-preserving anchor/focus text selection.

§Examples

use ailloli_ui_widgets::controls::{TerminalPosition, TerminalSelection};
let selection = TerminalSelection::new(TerminalPosition::new(0, 1), TerminalPosition::new(2, 3));
assert_eq!(selection.anchor.line, 0);

Fields§

§anchor: TerminalPosition

Position where dragging began.

§focus: TerminalPosition

Current drag position.

Implementations§

Source§

impl TerminalSelection

Source

pub const fn new(anchor: TerminalPosition, focus: TerminalPosition) -> Self

Creates a selection without ordering or bounds normalization.

§Examples
use ailloli_ui_widgets::controls::{TerminalPosition, TerminalSelection};
let selection = TerminalSelection::new(TerminalPosition::new(3, 2), TerminalPosition::new(1, 0));
assert_eq!(selection.normalized().0.line, 1);
Source

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

Selects from column zero of start through the end of end.

usize::MAX is used as the end-of-line sentinel and is clamped during painting; line indices are not validated here.

§Examples
use ailloli_ui_widgets::controls::TerminalSelection;
let selection = TerminalSelection::lines(2, 4);
assert_eq!((selection.anchor.column, selection.focus.column), (0, usize::MAX));
Source

pub fn normalized(self) -> (TerminalPosition, TerminalPosition)

Returns endpoints in lexicographic (line, column) order.

§Examples
use ailloli_ui_widgets::controls::{TerminalPosition, TerminalSelection};
let (start, end) = TerminalSelection::new(TerminalPosition::new(2, 0), TerminalPosition::new(1, 9)).normalized();
assert_eq!((start.line, end.line), (1, 2));
Source

pub fn clamp(self, line_count: usize) -> Option<Self>

Clamps both line indices to an available buffer.

Returns None for an empty buffer. Columns are retained verbatim and are clamped against line text only when rendered.

§Examples
use ailloli_ui_widgets::controls::TerminalSelection;
assert!(TerminalSelection::lines(1, 4).clamp(0).is_none());
assert_eq!(TerminalSelection::lines(1, 4).clamp(3).unwrap().focus.line, 2);

Trait Implementations§

Source§

impl Clone for TerminalSelection

Source§

fn clone(&self) -> TerminalSelection

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 TerminalSelection

Source§

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

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

impl Default for TerminalSelection

Source§

fn default() -> TerminalSelection

Returns the “default value” for a type. Read more
Source§

impl PartialEq for TerminalSelection

Source§

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

Source§

impl Eq for TerminalSelection

Source§

impl StructuralPartialEq for TerminalSelection

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
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.

§

impl<A> IntoClickAction<A> for A
where A: Clone + 'static,

§

fn into_click_action(self) -> ClickAction<A>

Implements the into_click_action helper used by this module.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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, 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.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> Brush for T
where T: Clone + PartialEq + Default + Debug,

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> Props for T
where T: Clone + 'static,