Struct DynamicCommandWidget

pub struct DynamicCommandWidget {
    pub command: DynamicCommand,
    /* private fields */
}

The widget for a command containing variables

Fields

command: DynamicCommand

The dynamic command

Implementations

impl DynamicCommandWidget

pub fn new(theme: &Theme, inline: bool, command: DynamicCommand) -> Self

Creates a new widget for the dynamic command

Methods from Deref<Target = DynamicCommand>

pub fn has_pending_variable(&self) -> bool

Checks if the command has any variables without value

pub fn current_variable(&self) -> Option<&Variable>

Retrieves the first variable without value in the command

pub fn current_variable_context( &self, ) -> impl IntoIterator<Item = (String, String)>

Retrieves the context for the current variable in the command

pub fn set_next_variable(&mut self, value: impl Into<String>)

Updates the first variable in the command for the given value

pub fn new_variable_value_for( &self, variable_name: impl Into<String>, value: impl Into<String>, ) -> VariableValue

Creates a VariableValue for this command with the given variable name and value

Trait Implementations

impl Clone for DynamicCommandWidget

fn clone(&self) -> DynamicCommandWidget

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DynamicCommandWidget

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

Formats the value using the given formatter.

impl Deref for DynamicCommandWidget

type Target = DynamicCommand

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for DynamicCommandWidget

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for DynamicCommandWidget

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

Formats the value using the given formatter.

impl Widget for &DynamicCommandWidget

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

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.