Skip to main content

CommandQueue

Struct CommandQueue 

Source
pub struct CommandQueue { /* private fields */ }
Expand description

Queue state for pre-parsed tmux commands.

Implementations§

Source§

impl CommandQueue

Source

pub fn new() -> Self

Creates an empty command queue.

Source

pub fn from_parsed(commands: ParsedCommands) -> Self

Builds a queue from one parsed command list.

Source

pub fn is_empty(&self) -> bool

Returns whether the queue currently has no pending commands.

Source

pub fn len(&self) -> usize

Returns the number of pending commands.

Source

pub fn items(&self) -> &VecDeque<QueuedCommand>

Returns the pending commands in queue order.

Source

pub fn append_parsed(&mut self, commands: ParsedCommands)

Appends a parsed command list to the back of the queue.

Source

pub fn insert_after_current(&mut self, commands: ParsedCommands)

Inserts a parsed command list immediately after the command currently being executed.

Callers pop the current item before firing it, so insertion after the current item is represented as prepending the newly built items before the remaining queue tail.

Source

pub fn pop_front(&mut self) -> Option<QueuedCommand>

Pops the next queue item.

Source

pub fn remove_group(&mut self, group: CommandGroup) -> usize

Removes all pending items from the same group.

This matches tmux cmdq_remove_group: the failed item has already fired, and only later items are eligible for removal.

Trait Implementations§

Source§

impl Clone for CommandQueue

Source§

fn clone(&self) -> CommandQueue

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CommandQueue

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CommandQueue

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for CommandQueue

Source§

impl PartialEq for CommandQueue

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CommandQueue

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.