Struct PaneSet 

pub struct PaneSet { /* private fields */ }

Owned group of pane handles.

Implementations

impl PaneSet

pub fn keyboard(&self) -> PaneSetKeyboard

Returns high-level keyboard actions broadcast to this pane set.

impl PaneSet

pub fn new<I>(panes: I) -> Self

where I: IntoIterator<Item = Pane>,

Creates a pane set from pane handles.

Preserves caller order exactly. It does not deduplicate repeated pane handles and may contain panes from different daemon endpoints.

pub fn panes(&self) -> &[Pane]

Returns the panes in their caller-provided order.

pub fn len(&self) -> usize

Returns the number of panes in the set.

pub fn is_empty(&self) -> bool

Returns true when the set contains no panes.

pub async fn broadcast(&self, input: Input<'_>) -> Result<BroadcastResult>

Broadcasts text or one key token to every pane.

This delegates to the client-side broadcast implementation and returns the same partial-broadcast error when at least one pane rejects the input.

pub async fn snapshot_all(&self) -> PaneSetBatch<PaneSnapshot>

Captures one fresh snapshot per pane.

The returned batch always contains per-pane successes and failures. Call PaneSetBatch::is_success when the caller requires every pane to succeed.

pub async fn close_all(self) -> PaneSetBatch<PaneCloseOutcome>

Closes every pane by consuming this pane set.

Stale panes use the ordinary Pane::close idempotent semantics and return PaneCloseOutcome::AlreadyClosed as a success.

pub fn expect_all(&self) -> PaneSetExpectation<'_>

Starts an all-panes visible-text expectation builder.

pub fn expect_any(&self) -> PaneSetExpectation<'_>

Starts an any-pane visible-text expectation builder.

pub fn wait_all(&self) -> PaneSetExpectation<'_>

Alias for Self::expect_all.

pub fn wait_any(&self) -> PaneSetExpectation<'_>

Alias for Self::expect_any.

Trait Implementations

impl Clone for PaneSet

fn clone(&self) -> PaneSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PaneSet

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

Formats the value using the given formatter.

impl Default for PaneSet

fn default() -> PaneSet

Returns the “default value” for a type.

impl From<Vec<Pane>> for PaneSet

fn from(panes: Vec<Pane>) -> Self

Converts to this type from the input type.

impl FromIterator<Pane> for PaneSet

fn from_iter<T: IntoIterator<Item = Pane>>(iter: T) -> Self

Creates a value from an iterator.

impl IntoIterator for PaneSet

type Item = Pane

The type of the elements being iterated over.

type IntoIter = IntoIter<Pane>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.