Struct CommandContext

pub struct CommandContext {
    pub context: EditContext,
    /* private fields */
}

Context object passed to each CommandFunc.

Fields

context: EditContext

Contextual information from user input.

Implementations

impl CommandContext

pub fn default_axis(&mut self, axis: Axis) -> &mut Self

Indicate a default Axis to use when one hasn’t been specified via a prefix command (e.g. :vertical).

pub fn default_relation(&mut self, relation: MoveDir1D) -> &mut Self

Indicate a default MoveDir1D value to use when one hasn’t been specified via a prefix command (e.g. :aboveleft).

pub fn axis(&self) -> Axis

Get the contextual Axis for newly opened windows.

pub fn relation(&self) -> MoveDir1D

Get the contextual MoveDir1D relation for newly opened windows.

pub fn open<I>( &self, target: OpenTarget<I::WindowId>, count: Count, ) -> Action<I>

where I: ApplicationInfo,

Use the contextual information to create a new WindowAction::Open for the given target and size.

pub fn split<I>( &self, target: OpenTarget<I::WindowId>, count: Count, ) -> Action<I>

where I: ApplicationInfo,

Use the contextual information to create a new WindowAction::Split for the given target and number of splits.

pub fn switch<I>(&self, target: OpenTarget<I::WindowId>) -> Action<I>

where I: ApplicationInfo,

If no contextual information has been provided, create a new WindowAction::Switch for the given target. If contextual information has been provided via commands like :tab, :vertical, or :aboveleft, then open the target in a new window instead.

This is meant to be a more user-friendly way to handle commands that switch to a new window by doing what the user like wanted when they used a prefix command.

pub fn window<I>( &self, target: OpenTarget<I::WindowId>, size: Option<Count>, ) -> Action<I>

where I: ApplicationInfo,

Open a new window for the given target.

If size is specified, the window will be opened with that width or height.

Trait Implementations

impl Clone for CommandContext

fn clone(&self) -> CommandContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommandContext

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

Formats the value using the given formatter.

impl Default for CommandContext

fn default() -> Self

Returns the “default value” for a type.

impl From<EditContext> for CommandContext

fn from(context: EditContext) -> Self

Converts to this type from the input type.

impl PartialEq for CommandContext

fn eq(&self, other: &CommandContext) -> 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 Eq for CommandContext

impl StructuralPartialEq for CommandContext