# pane.Pane.format

- **Module:** pane.Pane
- **Package:** libtmux
- **Language:** Rust
- **Kind:** method
- **Source:** https://github.com/libtmux/libtmux-rs/blob/8a648c0894dfffc9303583f753b6c8ae01f2fe76/crates/libtmux/src/pane.rs#L747
- **Page:** https://libtmux.org/reference/rs/pane-pane-format/

```
pane.Pane.format(self, template: &str) -> Result<TmuxText, Error>
```

Expand a tmux format string in this pane'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.

## Example

```rust
let guard = libtmux::test::TestServer::new().await?;
let session = guard.server().new_session("shown").await?;
let window = session.active_window().await?.expect("a window");
let pane = window.active_pane().await?.expect("a pane");

let expanded = pane.format("#{pane_id}").await?;
assert_eq!(expanded.to_string_lossy(), pane.id().to_string());

guard.shutdown().await?;
```