rmux-client 0.1.0

Blocking local client and attach-mode plumbing for the RMUX terminal multiplexer.
Documentation
use rmux_proto::{
    BreakPaneRequest, ClockModeRequest, CopyModeRequest, DisplayPanesRequest, JoinPaneRequest,
    KillPaneRequest, LastPaneRequest, MovePaneRequest, PaneTarget, PipePaneRequest, Request,
    ResizePaneAdjustment, ResizePaneRequest, RespawnPaneRequest, Response,
    SelectPaneAdjacentRequest, SelectPaneDirection, SelectPaneMarkRequest, SelectPaneRequest,
    SendKeysExtRequest, SendKeysRequest, SendPrefixRequest, SessionName, SwapPaneDirection,
    SwapPaneRequest, WindowTarget,
};

use crate::{connection::Connection, ClientError};

impl Connection {
    /// Sends a `swap-pane` request over the detached RPC channel.
    pub fn swap_pane(
        &mut self,
        source: PaneTarget,
        target: PaneTarget,
        detached: bool,
        preserve_zoom: bool,
    ) -> Result<Response, ClientError> {
        self.roundtrip(&Request::SwapPane(SwapPaneRequest {
            source,
            target,
            direction: None,
            detached,
            preserve_zoom,
        }))
    }

    /// Sends `swap-pane -D` over the detached RPC channel.
    pub fn swap_pane_with_next(
        &mut self,
        target: PaneTarget,
        detached: bool,
        preserve_zoom: bool,
    ) -> Result<Response, ClientError> {
        self.roundtrip(&Request::SwapPane(SwapPaneRequest {
            source: target.clone(),
            target,
            direction: Some(SwapPaneDirection::Down),
            detached,
            preserve_zoom,
        }))
    }

    /// Sends `swap-pane -U` over the detached RPC channel.
    pub fn swap_pane_with_previous(
        &mut self,
        target: PaneTarget,
        detached: bool,
        preserve_zoom: bool,
    ) -> Result<Response, ClientError> {
        self.roundtrip(&Request::SwapPane(SwapPaneRequest {
            source: target.clone(),
            target,
            direction: Some(SwapPaneDirection::Up),
            detached,
            preserve_zoom,
        }))
    }

    /// Sends a `last-pane` request over the detached RPC channel.
    pub fn last_pane(&mut self, target: WindowTarget) -> Result<Response, ClientError> {
        self.roundtrip(&Request::LastPane(LastPaneRequest { target }))
    }

    /// Sends a `join-pane` request over the detached RPC channel.
    pub fn join_pane(&mut self, request: JoinPaneRequest) -> Result<Response, ClientError> {
        self.roundtrip(&Request::JoinPane(request))
    }

    /// Sends a `move-pane` request over the detached RPC channel.
    pub fn move_pane(&mut self, request: MovePaneRequest) -> Result<Response, ClientError> {
        self.roundtrip(&Request::MovePane(request))
    }

    /// Sends a `break-pane` request over the detached RPC channel.
    pub fn break_pane(&mut self, request: BreakPaneRequest) -> Result<Response, ClientError> {
        self.roundtrip(&Request::BreakPane(request))
    }

    /// Sends a `resize-pane` request over the detached RPC channel.
    pub fn resize_pane(
        &mut self,
        target: PaneTarget,
        adjustment: ResizePaneAdjustment,
    ) -> Result<Response, ClientError> {
        self.roundtrip(&Request::ResizePane(ResizePaneRequest {
            target,
            adjustment,
        }))
    }

    /// Sends a `display-panes` request over the detached RPC channel.
    pub fn display_panes(
        &mut self,
        target: SessionName,
        duration_ms: Option<u64>,
        non_blocking: bool,
        no_command: bool,
        template: Option<String>,
    ) -> Result<Response, ClientError> {
        let request = Request::DisplayPanes(DisplayPanesRequest {
            target,
            duration_ms,
            non_blocking,
            no_command,
            template,
        });
        if non_blocking {
            self.roundtrip(&request)
        } else {
            self.roundtrip_without_read_timeout(&request)
        }
    }

    /// Sends a `pipe-pane` request over the detached RPC channel.
    pub fn pipe_pane(
        &mut self,
        target: PaneTarget,
        stdin: bool,
        stdout: bool,
        once: bool,
        command: Option<String>,
    ) -> Result<Response, ClientError> {
        self.roundtrip(&Request::PipePane(PipePaneRequest {
            target,
            stdin,
            stdout,
            once,
            command,
        }))
    }

    /// Sends a `respawn-pane` request over the detached RPC channel.
    pub fn respawn_pane(&mut self, request: RespawnPaneRequest) -> Result<Response, ClientError> {
        self.roundtrip(&Request::RespawnPane(request))
    }

    /// Sends a `select-pane` request over the detached RPC channel.
    pub fn select_pane(&mut self, target: PaneTarget) -> Result<Response, ClientError> {
        self.select_pane_with_title(target, None)
    }

    /// Sends a `select-pane` request with an optional title over the detached RPC channel.
    pub fn select_pane_with_title(
        &mut self,
        target: PaneTarget,
        title: Option<String>,
    ) -> Result<Response, ClientError> {
        self.roundtrip(&Request::SelectPane(SelectPaneRequest { target, title }))
    }

    /// Sends a directional `select-pane` request over the detached RPC channel.
    pub fn select_pane_adjacent(
        &mut self,
        target: PaneTarget,
        direction: SelectPaneDirection,
    ) -> Result<Response, ClientError> {
        self.roundtrip(&Request::SelectPaneAdjacent(SelectPaneAdjacentRequest {
            target,
            direction,
        }))
    }

    /// Sends `select-pane -m` or `select-pane -M` over the detached RPC channel.
    pub fn select_pane_mark(
        &mut self,
        target: PaneTarget,
        clear: bool,
    ) -> Result<Response, ClientError> {
        self.select_pane_mark_with_title(target, clear, None)
    }

    /// Sends `select-pane -m/-M` with an optional title over the detached RPC channel.
    pub fn select_pane_mark_with_title(
        &mut self,
        target: PaneTarget,
        clear: bool,
        title: Option<String>,
    ) -> Result<Response, ClientError> {
        self.roundtrip(&Request::SelectPaneMark(SelectPaneMarkRequest {
            target,
            clear,
            title,
        }))
    }

    /// Sends a `kill-pane` request over the detached RPC channel.
    pub fn kill_pane(&mut self, target: PaneTarget) -> Result<Response, ClientError> {
        self.kill_pane_with_options(target, false)
    }

    /// Sends a `kill-pane` request with extended tmux flags.
    pub fn kill_pane_with_options(
        &mut self,
        target: PaneTarget,
        kill_all_except: bool,
    ) -> Result<Response, ClientError> {
        self.roundtrip(&Request::KillPane(KillPaneRequest {
            target,
            kill_all_except,
        }))
    }

    /// Sends a `send-keys` request over the detached RPC channel.
    pub fn send_keys(
        &mut self,
        target: PaneTarget,
        keys: Vec<String>,
    ) -> Result<Response, ClientError> {
        self.roundtrip(&Request::SendKeys(SendKeysRequest { target, keys }))
    }

    /// Sends an extended `send-keys` request over the detached RPC channel.
    pub fn send_keys_extended(
        &mut self,
        request: SendKeysExtRequest,
    ) -> Result<Response, ClientError> {
        self.roundtrip(&Request::SendKeysExt(request))
    }

    /// Sends a `send-prefix` request over the detached RPC channel.
    pub fn send_prefix(
        &mut self,
        target: Option<PaneTarget>,
        secondary: bool,
    ) -> Result<Response, ClientError> {
        self.roundtrip(&Request::SendPrefix(SendPrefixRequest {
            target,
            secondary,
        }))
    }

    /// Sends a `copy-mode` request over the detached RPC channel.
    pub fn copy_mode(&mut self, request: CopyModeRequest) -> Result<Response, ClientError> {
        self.roundtrip(&Request::CopyMode(request))
    }

    /// Sends a `clock-mode` request over the detached RPC channel.
    pub fn clock_mode(&mut self, target: Option<PaneTarget>) -> Result<Response, ClientError> {
        self.roundtrip(&Request::ClockMode(ClockModeRequest { target }))
    }
}