Skip to main content

Viewport

Struct Viewport 

Source
pub struct Viewport { /* private fields */ }
Expand description

The visible part of a text pane, including any rendered gutter columns.

top is a zero-based logical line. left, width, gutter, and the retained desired column are terminal display cells, not UTF-8 byte columns. The viewport does not own wrapping or rendered text: callers supply the same logical line snapshot to apply that they display.

Implementations§

Source§

impl Viewport

Source

pub fn new( top: usize, left: usize, height: usize, width: usize, gutter: usize, ) -> Self

Creates a viewport in terminal display cells.

Zero height or width is normalized to one so reveal calculations remain total. top and left may initially be beyond the supplied text; motion application clamps or adjusts them as needed.

Source

pub fn with_desired_column(self, desired_column: Option<usize>) -> Self

Restores the desired display column retained by vertical motions.

None derives the first desired column from the current cursor. After each motion, apply stores the column needed for a later j or k; callers preserving a viewport between calls normally do not need to set this themselves.

Source

pub const fn top(&self) -> usize

Returns the zero-based first visible logical line.

Source

pub const fn left(&self) -> usize

Returns the first visible terminal column, including the gutter.

Source

pub const fn height(&self) -> usize

Returns the viewport height in logical lines (always at least one).

Source

pub const fn width(&self) -> usize

Returns the viewport width in terminal display cells (always at least one).

Source

pub const fn gutter(&self) -> usize

Returns the rendered gutter width in terminal display cells.

Source

pub const fn desired_column(&self) -> Option<usize>

Returns the retained source-text display column used by vertical motions.

Trait Implementations§

Source§

impl Clone for Viewport

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Viewport

Source§

impl Debug for Viewport

Source§

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

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

impl Eq for Viewport

Source§

impl PartialEq for Viewport

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Viewport

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.