Struct BufferCopy item path

Returns a Buffer with all cells set to the default one

Returns a Buffer with all cells initialized with the attributes of the given Cell

Returns a Buffer containing the given lines

Returns the content of the buffer as a slice

Returns the area covered by this buffer

Returns a reference to the Cell at the given coordinates

Callers should use Buffer[] or Buffer::cell instead of this method.

Note: idiomatically methods named get usually return Option<&T>, but this method panics instead. This is kept for backwards compatibility. See cell for a safe alternative.

§Panics

Panics if the index is out of bounds.

Returns a mutable reference to the Cell at the given coordinates.

Callers should use Buffer[] or Buffer::cell_mut instead of this method.

Note: idiomatically methods named get_mut usually return Option<&mut T>, but this method panics instead. This is kept for backwards compatibility. See cell_mut for a safe alternative.

§Panics

Panics if the position is outside the Buffer’s area.

Returns a reference to the Cell at the given position or None if the position is outside the Buffer’s area.

This method accepts any value that can be converted to Position (e.g. (x, y) or Position::new(x, y)).

For a method that panics when the position is outside the buffer instead of returning None, use Buffer[].

§Examples

use ratatui_core::buffer::{Buffer, Cell};
use ratatui_core::layout::{Position, Rect};

let mut buffer = Buffer::empty(Rect::new(0, 0, 10, 10));

assert_eq!(buffer.cell(Position::new(0, 0)), Some(&Cell::default()));
assert_eq!(buffer.cell(Position::new(10, 10)), None);
assert_eq!(buffer.cell((0, 0)), Some(&Cell::default()));
assert_eq!(buffer.cell((10, 10)), None);

Returns a mutable reference to the Cell at the given position or None if the position is outside the Buffer’s area.

This method accepts any value that can be converted to Position (e.g. (x, y) or Position::new(x, y)).

For a method that panics when the position is outside the buffer instead of returning None, use Buffer[].

§Examples

use ratatui_core::buffer::{Buffer, Cell};
use ratatui_core::layout::{Position, Rect};
use ratatui_core::style::{Color, Style};
let mut buffer = Buffer::empty(Rect::new(0, 0, 10, 10));

if let Some(cell) = buffer.cell_mut(Position::new(0, 0)) {
    cell.set_symbol("A");
}
if let Some(cell) = buffer.cell_mut((0, 0)) {
    cell.set_style(Style::default().fg(Color::Red));
}

Returns the index in the Vec<Cell> for the given global (x, y) coordinates.

Global coordinates are offset by the Buffer’s area offset (x/y).

§Examples

use ratatui_core::buffer::Buffer;
use ratatui_core::layout::Rect;

let buffer = Buffer::empty(Rect::new(200, 100, 10, 10));
// Global coordinates to the top corner of this buffer's area
assert_eq!(buffer.index_of(200, 100), 0);

§Panics

Panics when given an coordinate that is outside of this Buffer’s area.

use ratatui_core::buffer::Buffer;
use ratatui_core::layout::Rect;

let buffer = Buffer::empty(Rect::new(200, 100, 10, 10));
// Top coordinate is outside of the buffer in global coordinate space, as the Buffer's area
// starts at (200, 100).
buffer.index_of(0, 0); // Panics

Returns the (global) coordinates of a cell given its index

Global coordinates are offset by the Buffer’s area offset (x/y).

§Examples

use ratatui_core::buffer::Buffer;
use ratatui_core::layout::Rect;

let rect = Rect::new(200, 100, 10, 10);
let buffer = Buffer::empty(rect);
assert_eq!(buffer.pos_of(0), (200, 100));
assert_eq!(buffer.pos_of(14), (204, 101));

§Panics

Panics when given an index that is outside the Buffer’s content.

use ratatui_core::buffer::Buffer;
use ratatui_core::layout::Rect;

let rect = Rect::new(0, 0, 10, 10); // 100 cells in total
let buffer = Buffer::empty(rect);
// Index 100 is the 101th cell, which lies outside of the area of this Buffer.
buffer.pos_of(100); // Panics

Print a string, starting at the position (x, y)

Print at most the first n characters of a string if enough space is available until the end of the line. Skips zero-width graphemes and control characters.

Use Buffer::set_string when the maximum amount of characters can be printed.

Print a line, starting at the position (x, y)

Print a span, starting at the position (x, y)

Set the style of all cells in the given area.

style accepts any type that is convertible to Style (e.g. Style, Color, or your own type that implements Into<Style>).

Resize the buffer so that the mapped area matches the given area and that the buffer length is equal to area.width * area.height

Reset all cells in the buffer

Merge an other buffer into this one

Builds a minimal sequence of coordinates and Cells necessary to update the UI from self to other.

We’re assuming that buffers are well-formed, that is no double-width cell is followed by a non-blank cell.

§Multi-width characters handling:

(Index:) `01`
Prev:    `コ`
Next:    `aa`
Updates: `0: a, 1: a'

(Index:) `01`
Prev:    `a `
Next:    `コ`
Updates: `0: コ` (double width symbol at index 0 - skip index 1)

(Index:) `012`
Prev:    `aaa`
Next:    `aコ`
Updates: `0: a, 1: コ` (double width symbol at index 1 - skip index 2)

Writes a debug representation of the buffer to the given formatter.

The format is like a pretty printed struct, with the following fields:

• area: displayed as Rect { x: 1, y: 2, width: 3, height: 4 }
• content: displayed as a list of strings representing the content of the buffer
• styles: displayed as a list of: { x: 1, y: 2, fg: Color::Red, bg: Color::Blue, modifier: Modifier::BOLD } only showing a value when there is a change in style.

Returns a reference to the Cell at the given position.

This method accepts any value that can be converted to Position (e.g. (x, y) or Position::new(x, y)).

§Panics

May panic if the given position is outside the buffer’s area. For a method that returns None instead of panicking, use Buffer::cell.

§Examples

use ratatui_core::buffer::{Buffer, Cell};
use ratatui_core::layout::{Position, Rect};

let buf = Buffer::empty(Rect::new(0, 0, 10, 10));
let cell = &buf[(0, 0)];
let cell = &buf[Position::new(0, 0)];

Returns a mutable reference to the Cell at the given position.

This method accepts any value that can be converted to Position (e.g. (x, y) or Position::new(x, y)).

§Panics

May panic if the given position is outside the buffer’s area. For a method that returns None instead of panicking, use Buffer::cell_mut.

§Examples

use ratatui_core::buffer::{Buffer, Cell};
use ratatui_core::layout::{Position, Rect};

let mut buf = Buffer::empty(Rect::new(0, 0, 10, 10));
buf[(0, 0)].set_symbol("A");
buf[Position::new(0, 0)].set_symbol("B");

Returns the argument unchanged.

Calls U::from(self).

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