Struct Metadata

pub struct Metadata {
    pub version: String,
    pub client: Client,
    pub sessions: Vec<Session>,
    pub windows: Vec<Window>,
    pub panes: Vec<Pane>,
}

Describes the Tmux sessions, windows & panes stored in a backup.

This is enough information to recreate all sessions, windows & panes.

Fields

version: String

Version of the archive’s format.

client: Client

Tmux client metadata.

sessions: Vec<Session>

Tmux sessions metadata.

windows: Vec<Window>

Tmux windows metadata.

panes: Vec<Pane>

Tmux panes metadata.

Implementations

impl Metadata

pub async fn new() -> Result<Self>

Query Tmux and return a new Metadata.

pub async fn read_file<P: AsRef<Path>>(backup_filepath: P) -> Result<Self>

Open the archive file at backup_filepath and read the version string and tmux metadata.

pub fn overview(&self) -> Overview

Return an overview of the metadata.

pub fn windows_related_to(&self, session: &Session) -> Vec<Window>

Return the list of windows in the provided session.

pub fn panes_related_to(&self, window: &Window) -> Vec<&Pane>

Return the list of panes in the provided window.

Trait Implementations

impl Debug for Metadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Metadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Metadata

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.