Struct GraphicBlock

pub struct GraphicBlock<'a> {
    pub(crate) position: Position,
    image: Span<'a>,
    pub enabled: bool,
}

A struct representing a graphical block that can be displayed in the game logic. It holds the position and visual representation (image) of the block.

Fields

• position: The position of the graphic block on the screen.
• image: The visual representation of the block, using a styled Span.

Fields

position: Position

image: Span<'a>

enabled: bool

Implementations

impl<'a> GraphicBlock<'a>

pub fn new(position: Position, image: &'a str, style: Style) -> GraphicBlock<'a>

Creates a new GraphicBlock with the specified position, image, and style.

Parameters

• position: The position of the graphic block.
• image: The string that represents the image of the block.
• style: The style applied to the image of the block.

Returns

A new GraphicBlock instance with the given position, image, and style.

Note

If you want less lifetime propagation, this code can be refactorised to take to use a static string for the image using 'static lifetime. But for a more general use, the lifetime parameter is better, allowing dynamic text (e.g., changing each time) If you want no lifetime and dynamic text, add an own String, to GraphicBlock and generate for each rendering a new Span, but this might affect performance.

pub fn set_position(&mut self, position: Position)

Sets the position of the graphic block.

Parameters

• position: The new position to set for the block.

pub fn enable(&mut self)

pub fn disable(&mut self)

pub fn get_position(&self) -> &Position

Retrieves the current position of the graphic block.

Returns

A reference to the current position of the graphic block.

pub fn get_content(&self) -> &str

Retrieves the current position of the graphic block.

Returns

A reference to the current position of the graphic block.

Trait Implementations

impl<'a> Clone for GraphicBlock<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for GraphicBlock<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for GraphicBlock<'a>

fn eq(&self, other: &GraphicBlock<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Widget for GraphicBlock<'_>

Backward compatibility implementation for the Widget trait.

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

Renders the graphic block into the given buffer, using the render_ref method.

Parameters

• area: The area in the terminal where the graphic block should be rendered.
• buf: A mutable reference to the buffer where the block will be drawn.

impl WidgetRef for GraphicBlock<'_>

NB: Could also have used impl Widget for &T even if more limited see: https://github.com/ratatui/ratatui/discussions/1274

fn render_ref(&self, area: Rect, buf: &mut Buffer)

Renders the graphic block into the given buffer.

Parameters

• area: The area in the terminal where the graphic block should be rendered.
• buf: A mutable reference to the buffer where the block will be drawn.

Behavior

If the block is outside the visible area, it will not be drawn, avoiding any panics. The game logic will not crash even if part of the block is outside the visible area due to window resizing.

impl<'a> StructuralPartialEq for GraphicBlock<'a>