Struct LineNumbers

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

Renders line-numbers.

Stateful

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

Implementations

impl<'a> LineNumbers<'a>

pub fn new() -> Self

pub fn start(self, start: upos_type) -> Self

Start position.

pub fn end(self, end: upos_type) -> Self

End position.

pub fn cursor(self, cursor: upos_type) -> Self

Current line for highlighting.

pub fn relative(self, relative: bool) -> Self

Numbering relative to cursor

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

Extra info.

pub fn flag_width(self, width: u16) -> Self

Required width for the flags.

pub fn margin(self, margin: (u16, u16)) -> Self

Extra margin.

pub fn format(self, format: NumberFormat) -> Self

Line number format.

pub fn styles(self, styles: LineNumberStyle) -> Self

Complete set of styles.

pub fn style(self, style: Style) -> Self

Base style.

pub fn cursor_style(self, style: Style) -> Self

Style for current line.

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

Block.

pub fn width(&self) -> u16

Calculates the necessary width for the configuration.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for LineNumbers<'a>

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

Formats the value using the given formatter.

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

fn default() -> LineNumbers<'a>

Returns the “default value” for a type.

impl StatefulWidget for LineNumbers<'_>

type State = LineNumberState

State associated with the stateful widget.

fn render(self, area: Rect, buf: &mut Buffer, state: &mut Self::State)

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