Struct SessionName 

pub struct SessionName(/* private fields */);

A validated RMUX session name.

Empty strings are rejected. : and . characters are rewritten to _ to keep names safe for use inside exact target syntax (session, session:window, session:window.pane). Non-printable characters are rendered using tmux’s vis-style escape sequences so display output is always single-line and non-controlling.

Implementations

impl SessionName

pub fn new(value: impl Into<String>) -> Result<SessionName, RmuxError>

Validates and stores a session name using tmux-compatible rewriting.

pub fn as_str(&self) -> &str

Returns the sanitized validated session name.

pub fn into_inner(self) -> String

Consumes the wrapper and returns the sanitized string.

Trait Implementations

impl AsRef<str> for SessionName

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for SessionName

fn clone(&self) -> SessionName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SessionName

fn deserialize<D>( deserializer: D, ) -> Result<SessionName, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SessionName

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

Formats the value using the given formatter.

impl Eq for SessionName

impl FromStr for SessionName

type Err = RmuxError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<SessionName, <SessionName as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for SessionName

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SessionName

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SessionName

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SessionName

impl TryFrom<&str> for SessionName

type Error = RmuxError

The type returned in the event of a conversion error.

fn try_from( value: &str, ) -> Result<SessionName, <SessionName as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<String> for SessionName

type Error = RmuxError

The type returned in the event of a conversion error.

fn try_from( value: String, ) -> Result<SessionName, <SessionName as TryFrom<String>>::Error>

Performs the conversion.