Struct arkham::prelude::Rune

pub struct Rune {
    pub content: Option<char>,
    pub fg: Option<Color>,
    pub bg: Option<Color>,
    pub bold: bool,
}

Rune repesents the state of the screen at a specific position. It stores the character content and styling information that will be rendered.

Fields

content: Option<char>

fg: Option<Color>

bg: Option<Color>

bold: bool

Implementations

impl Rune

pub fn new() -> Self

Create a new empty Rune. This can be used with the settings functions as a builder pattern

Example:

use arkham::prelude::*;
let rune:Rune = Rune::new().bg(Color::Blue).fg(Color::White).bold();

Examples found in repository

examples/component_functions.rs (line 9)

fn root(ctx: &mut ViewContext) {
    let size = ctx.size();
    ctx.fill(size, Rune::new().bg(Color::DarkGrey));
    ctx.component(Rect::new((10, 10), (20, 1)), hello_world);
    ctx.component(Rect::new(0, (size.width, 1)), quit_nag);
}

examples/component_params.rs (line 9)

fn root(ctx: &mut ViewContext) {
    let size = ctx.size();
    ctx.fill(size, Rune::new().bg(Color::DarkGrey));
    ctx.component(Rect::new((10, 10), (20, 1)), say_hello("Alice"));
    ctx.component(Rect::new(0, (size.width, 1)), quit_nag);
}

examples/simple.rs (line 9)

fn root(ctx: &mut ViewContext) {
    let size = ctx.size();
    ctx.fill(size, Rune::new().bg(Color::DarkGrey));
    ctx.insert((10, 10), "Hello World");
    ctx.insert(
        ((size.width / 2) - 7, 0),
        "Press Q to Quit".to_runes().fg(Color::Red),
    );
}

examples/keyboard.rs (line 9)

fn root(ctx: &mut ViewContext) {
    let size = ctx.size();
    ctx.fill(size, Rune::new().bg(Color::DarkGrey));
    ctx.component(((10, 10), (30, 1)), hello_world);
    ctx.component(((10, 11), (20, 1)), show_key_press);
    ctx.component((0, (size.width, 1)), quit_nag);
}

pub fn content(self, content: char) -> Self

Set the content of the rune. The rune’s content is a single character.

Example:

use arkham::prelude::*;
let rune = Rune::new().content('A');
assert_eq!(rune.content, Some('A'));

pub fn bg(self, bg: Color) -> Self

Set the background color of the rune.

Example:

use arkham::prelude::*;
let rune = Rune::new().bg(Color::Green);
assert_eq!(rune.bg, Some(Color::Green));

Examples found in repository

examples/component_functions.rs (line 9)

fn root(ctx: &mut ViewContext) {
    let size = ctx.size();
    ctx.fill(size, Rune::new().bg(Color::DarkGrey));
    ctx.component(Rect::new((10, 10), (20, 1)), hello_world);
    ctx.component(Rect::new(0, (size.width, 1)), quit_nag);
}

examples/component_params.rs (line 9)

fn root(ctx: &mut ViewContext) {
    let size = ctx.size();
    ctx.fill(size, Rune::new().bg(Color::DarkGrey));
    ctx.component(Rect::new((10, 10), (20, 1)), say_hello("Alice"));
    ctx.component(Rect::new(0, (size.width, 1)), quit_nag);
}

examples/simple.rs (line 9)

fn root(ctx: &mut ViewContext) {
    let size = ctx.size();
    ctx.fill(size, Rune::new().bg(Color::DarkGrey));
    ctx.insert((10, 10), "Hello World");
    ctx.insert(
        ((size.width / 2) - 7, 0),
        "Press Q to Quit".to_runes().fg(Color::Red),
    );
}

examples/keyboard.rs (line 9)

fn root(ctx: &mut ViewContext) {
    let size = ctx.size();
    ctx.fill(size, Rune::new().bg(Color::DarkGrey));
    ctx.component(((10, 10), (30, 1)), hello_world);
    ctx.component(((10, 11), (20, 1)), show_key_press);
    ctx.component((0, (size.width, 1)), quit_nag);
}

pub fn fg(self, fg: Color) -> Self

Set the text color of the rune.

Example:

use arkham::prelude::*;
let rune = Rune::new().fg(Color::Green);
assert_eq!(rune.fg, Some(Color::Green));

pub fn bold(self) -> Self

Set the text color of the rune.

Example:

use arkham::prelude::*;
let rune = Rune::new().fg(Color::Green);
assert_eq!(rune.fg, Some(Color::Green));

Trait Implementations

impl Add for Rune

type Output = Rune

The resulting type after applying the + operator.

fn add(self, rhs: Rune) -> Self::Output

Performs the + operation.

impl Clone for Rune

fn clone(&self) -> Rune

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Rune

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

Formats the value using the given formatter.

impl Default for Rune

fn default() -> Rune

Returns the “default value” for a type.

impl From<Color> for Rune

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Rune> for Runes

fn from(value: Rune) -> Self

Converts to this type from the input type.

impl From<char> for Rune

fn from(value: char) -> Self

Converts to this type from the input type.

impl PartialEq for Rune

fn eq(&self, other: &Rune) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for Rune

impl Eq for Rune

impl StructuralPartialEq for Rune