Enum PluginOutputMessages 

#[non_exhaustive]
pub enum PluginOutputMessages {
    OutputText {
        text: String,
        coordinates: (u32, u32),
        bg: Option<Colour>,
        fg: Option<Colour>,
    },
    OutputCells(Vec<Cell>),
    OutputPixels(Vec<Pixel>),
}

All the message kinds that the plugin can send to Tattoy.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

OutputText

Output from the plugin that renders text of arbitrary length in the terminal.

Fields

text: String

The text to display.

coordinates: (u32, u32)

The coordinates. [0, 0] is in the top-left.

bg: Option<Colour>

An optional colour for the text’s background.

fg: Option<Colour>

An optional colour for the text’s foreground.

OutputCells(Vec<Cell>)

Output an arbitrary amount of cells to the terminal. It does not need to include blank cells.

OutputPixels(Vec<Pixel>)

Output from the plugin that renders pixels in the terminal.

Trait Implementations

impl Clone for PluginOutputMessages

fn clone(&self) -> PluginOutputMessages

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PluginOutputMessages

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PluginOutputMessages

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PluginOutputMessages

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.