Struct PlumbingMessage 

pub struct PlumbingMessage {
    pub src: Option<String>,
    pub dst: Option<String>,
    pub wdir: Option<String>,
    pub cur: usize,
    pub attrs: BTreeMap<String, String>,
    pub data: String,
}

The deserialized form of a plumbing message sent by a client.

Fields

src: Option<String>

The application or service generating the message

dst: Option<String>

The destination “port” for the message

wdir: Option<String>

The working directory (used when data is a filename)

cur: usize

The offset within ‘data’ where the user’s cursor currently lies (default=0). If a rule specifies a ‘narrows-to’ rule it will be used to narrow initial data to only include the specified cursor, otherwise the match will be rejected.

attrs: BTreeMap<String, String>

Name=value pairs. Must not contain newlines

data: String

The string content of the message itself

Trait Implementations

impl Clone for PlumbingMessage

fn clone(&self) -> PlumbingMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PlumbingMessage

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

Formats the value using the given formatter.

impl Default for PlumbingMessage

fn default() -> PlumbingMessage

Returns the “default value” for a type.

impl Eq for PlumbingMessage

impl FromStr for PlumbingMessage

type Err = String

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl PartialEq for PlumbingMessage

fn eq(&self, other: &PlumbingMessage) -> 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 StructuralPartialEq for PlumbingMessage