Struct KeyHints 

pub struct KeyHints {
    pub common: Common,
    pub hints: Vec<Hint>,
}

ratatui-style key hints line (§4.5.2): enter open · n new.

Fields

common: Common

Common node props (key, style, block, fallback).

hints: Vec<Hint>

Hints, in display order.

Implementations

impl KeyHints

pub fn new(hints: impl IntoIterator<Item = impl Into<Hint>>) -> Self

Hints from anything convertible to Hint (("enter", "open") tuples).

pub fn hint_action(self, keys: &str, action: impl Into<ActionId>) -> Self

Attaches an action to the hint with the given keys (§11.3).

Trait Implementations

impl Clone for KeyHints

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyHints

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

Formats the value using the given formatter.

impl Default for KeyHints

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for KeyHints

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<KeyHints> for Node

fn from(k: KeyHints) -> Self

Converts to this type from the input type.

impl IntoNode for KeyHints

fn into_node(self) -> Node

Converts into a node.

impl PartialEq for KeyHints

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for KeyHints

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for KeyHints

impl WithCommon for KeyHints

fn common_mut(&mut self) -> &mut Common

Mutable access to the node’s common props.

fn key(self, key: impl Into<Key>) -> Self

Sets the node key.

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

Sets the base style.

fn block(self, block: impl Into<BlockProps>) -> Self

Sets the surrounding block.

fn fallback(self, node: impl Into<Node>) -> Self

Sets the fallback node.