Struct SessionPaths 

pub struct SessionPaths {
    pub root: PathBuf,
    pub socket: PathBuf,
    pub pid: PathBuf,
    pub layout: PathBuf,
    pub panes: PathBuf,
}

Fields

root: PathBuf

socket: PathBuf

pid: PathBuf

layout: PathBuf

panes: PathBuf

Implementations

impl SessionPaths

pub fn sessions_root_from_home() -> Result<PathBuf>

Return the root directory containing all muxr session directories under $HOME.

Errors

• HOME is unavailable in the current environment.

pub fn sessions_root_from_home_path(home: PathBuf) -> PathBuf

Return the root directory containing all muxr session directories under an explicit home path.

pub fn from_home(session: &SessionName) -> Result<Self>

Build muxr session paths under $HOME/.local/state/muxr.

Errors

• HOME is unavailable in the current environment.
• The derived Unix socket path is too long for the platform socket address.

pub fn from_sessions_root_path( sessions_root: &Path, session: &SessionName, ) -> Result<Self>

Build muxr session paths from an explicit sessions root.

Errors

• The sessions root has no parent state directory.
• The derived Unix socket path is too long for the platform socket address.

pub fn logs_root(&self) -> Result<PathBuf>

Build the centralized directory containing muxr server logs.

Errors

• The session root path has no parent state root.

pub fn server_log_path( &self, session: &SessionName, timestamp: &ServerLogTimestamp, pid: u32, ) -> Result<PathBuf>

Build the centralized server log path for one muxr server process start.

Errors

• The session root path has no parent state root.

pub fn server_log_file_pattern(session: &SessionName, pid: u32) -> String

Return the pid-scoped server log filename pattern used in client startup failure hints.

The timestamp is chosen inside the server, so the client can only know the session name and spawned pid.

fn from_home_path(home: PathBuf, session: &SessionName) -> Result<Self>

fn from_state_root_path( state_root: &Path, session: &SessionName, ) -> Result<Self>

fn state_root_from_home_path(home: PathBuf) -> PathBuf

fn state_root(&self) -> Result<&Path>

Trait Implementations

impl Clone for SessionPaths

fn clone(&self) -> SessionPaths

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionPaths

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SessionPaths

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SessionPaths

impl PartialEq for SessionPaths

fn eq(&self, other: &SessionPaths) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for SessionPaths

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SessionPaths