Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

method libtmux-rs latest

Session.refresh

Replace this handle's snapshot with the session's current state.

Source and package
Qualified name
libtmux::session::Session::refresh
Module
session
Declared in
Session
Package
libtmux
Source
crates/libtmux/src/session.rs
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby Lua TypeScriptGoJavaC#C++ Swift Kotlin Scala OCaml F# Clojure
pub async fn refresh(&mut self) -> Result<&mut Self, Error>

Description#

Only the receiver changes. Clones keep the snapshot they were taken with, because each handle owns its own.

Errors

Returns Error::ObjectGone when the session no longer exists, or a listing error when tmux could not be read.

Guides#

Pages that discuss refresh.

In other ports#

Read a session again

Equivalents of Read a session again in other languages
Language Equivalent
Python libtmux.Session.refresh
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript session.Session.refreshed
Go tmux.Session.Refresh
Java io.github.libtmux.Session.refresh
C# LibTmux.Session.RefreshAsync
C++ libtmux::Session::refresh
Swift reads are snapshots; Server.snapshot() takes a new one rather than refreshing a handle
OCaml No direct public OCaml equivalent is recorded for this operation.
Perl Acquire a new snapshot; retained captured entities never refresh in place.

No equivalent is recorded in Ruby, Lua, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.

Esc

Type to search.

Reference previewOpen reference