On this page

session.Session.format

Module: session
Declared in: Session
Package: libtmux
Source: crates/libtmux/src/session.rs

format ( self , template : &str ) → Result<TmuxText, Error> method [source] ¶ method [source] ¶ format

Expand a tmux format string in this session's context.

This returns display-message output instead of showing it in front of a person with Self::display. See crate::Server::format for the shell boundary around command and recursive formats.

Errors

Returns an error when tmux cannot be reached or refuses the format.

Examples

let guard = libtmux::test::TestServer::new().await?;
let session = guard.server().new_session("shown").await?;

let expanded = session.format("#{session_name}").await?;
assert_eq!(expanded.to_string_lossy(), "shown");

guard.shutdown().await?;

0 declared, 0 inherited