LineNumbers

Struct LineNumbers 

Source
pub struct LineNumbers<'a> { /* private fields */ }
Expand description

Renders line-numbers.

§Stateful

This widget implements StatefulWidget, you can use it with LineNumberState to handle common actions.

Implementations§

Source§

impl<'a> LineNumbers<'a>

Source

pub fn new() -> LineNumbers<'a>

Source

pub fn with_textarea(self, text_area: &'a TextAreaState) -> LineNumbers<'a>

Sync with this text-area.

To make this work correctly, the TextArea must be rendered first to make sure that all layout-information stored in the state is accurate.

Source

pub fn start(self, start: u32) -> LineNumbers<'a>

Start position.

Source

pub fn end(self, end: u32) -> LineNumbers<'a>

End position.

Source

pub fn cursor(self, cursor: u32) -> LineNumbers<'a>

Current line for highlighting.

Source

pub fn relative(self, relative: bool) -> LineNumbers<'a>

Numbering relative to cursor

Source

pub fn flags(self, flags: Vec<Line<'a>>) -> LineNumbers<'a>

Extra info.

This is a Vec that matches up the visible lines.

Source

pub fn flag_width(self, width: u16) -> LineNumbers<'a>

Required width for the flags.

Source

pub fn margin(self, margin: (u16, u16)) -> LineNumbers<'a>

Extra margin as (left-margin, right-margin).

Source

pub fn format(self, format: NumberFormat) -> LineNumbers<'a>

Line number format.

Source

pub fn styles(self, styles: LineNumberStyle) -> LineNumbers<'a>

Complete set of styles.

Source

pub fn style(self, style: Style) -> LineNumbers<'a>

Base style.

Source

pub fn cursor_style(self, style: Style) -> LineNumbers<'a>

Style for current line.

Source

pub fn block(self, block: Block<'a>) -> LineNumbers<'a>

Block.

Source

pub fn width_for( start_nr: u32, flag_width: u16, margin: (u16, u16), block: u16, ) -> u16

Required width for the line-numbers.

Trait Implementations§

Source§

impl<'a> Clone for LineNumbers<'a>

Source§

fn clone(&self) -> LineNumbers<'a>

Returns a duplicate 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<'a> Debug for LineNumbers<'a>

Source§

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

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

impl<'a> Default for LineNumbers<'a>

Source§

fn default() -> LineNumbers<'a>

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

impl StatefulWidget for LineNumbers<'_>

Source§

type State = LineNumberState

State associated with the stateful widget. Read more
Source§

fn render( self, area: Rect, buf: &mut Buffer, state: &mut <LineNumbers<'_> as StatefulWidget>::State, )

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom stateful widget.

Auto Trait Implementations§

§

impl<'a> Freeze for LineNumbers<'a>

§

impl<'a> !RefUnwindSafe for LineNumbers<'a>

§

impl<'a> !Send for LineNumbers<'a>

§

impl<'a> !Sync for LineNumbers<'a>

§

impl<'a> Unpin for LineNumbers<'a>

§

impl<'a> !UnwindSafe for LineNumbers<'a>

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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.