Struct Endpoint 

pub struct Endpoint {
    pub namespace_id: String,
    pub path: String,
}

Fields

namespace_id: String

mount-ns id when known

path: String

pipe name / socket path / TCP loopback

Implementations

impl Endpoint

pub fn windows_pipe( namespace_id: impl Into<String>, pipe_name: impl Into<String>, ) -> Result<Self, EndpointNameError>

Build a Windows named-pipe endpoint identity from a bare pipe name.

running-process resolves endpoint paths through interprocess’s GenericNamespaced name type, which prepends \\.\pipe\ itself. Passing an already-prefixed path silently addresses the wrong pipe, so this constructor rejects it.

Available on every platform so cross-platform consumers can construct endpoint identities for manifests and diagnostics.

use running_process::broker::protocol::Endpoint;

let endpoint = Endpoint::windows_pipe("my-daemon", "my-daemon-pipe").unwrap();
assert_eq!(endpoint.path, "my-daemon-pipe");
assert!(Endpoint::windows_pipe("my-daemon", r"\\.\pipe\my-daemon-pipe").is_err());

Errors

EndpointNameError::PrefixedPipeName when pipe_name starts with \\.\pipe\ (or the forward-slash spelling), and EndpointNameError::Empty for an empty name.

pub fn unix_socket( namespace_id: impl Into<String>, socket_path: impl Into<String>, ) -> Result<Self, EndpointNameError>

Build a Unix-domain-socket endpoint identity from a filesystem path.

Available on every platform so cross-platform consumers can construct endpoint identities for manifests and diagnostics.

Errors

EndpointNameError::Empty for an empty path.

Trait Implementations

impl Clone for Endpoint

fn clone(&self) -> Endpoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Endpoint

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

Formats the value using the given formatter.

impl Default for Endpoint

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Endpoint

impl Hash for Endpoint

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

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 Message for Endpoint

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Endpoint

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