Struct RegistrationFile 

pub struct RegistrationFile {
    pub kind: RegistrationKind,
    pub role: Option<String>,
    pub root: PathBuf,
    pub pid: u32,
    pub version: String,
    pub runtime: Option<String>,
    pub placement: Option<String>,
}

The one file that names a workspace’s endpoint: <runtime>/<digest>.json.

It answers without touching the workspace what run/socket answered for a path and what a state.db/client.db guess answered for a surface: who serves this tree (kind, role), which tree it is (root), which process (pid), which wire version, and which runtime hosts the role’s sessions (runtime, the field external-runtime plugins match to find their clients).

The writer’s facts are the file’s facts. A bind does not publish one on its own, because a bind does not know whether it belongs to an admin root or a role workspace: the serving side calls write_registration or SocketEndpoint::publish with the surface it knows.

Fields

kind: RegistrationKind

Which side of the socket this process serves.

role: Option<String>

The role this client serves; None for a server root. null in JSON.

root: PathBuf

The canonical spelling of the tree the socket belongs to.

pid: u32

The pid of the process serving it, restated at every bind.

version: String

The writer’s version, WIRE_VERSION for this crate.

runtime: Option<String>

The runtime hosting the role’s sessions (pi, acp, …); None for a server root. null in JSON.

placement: Option<String>

Where this machine displays the role’s runtime process (orca, zellij, headless, external); None for a server root, and for a client that published its registration before it resolved one.

Placement is a property of the machine, which is why it is recorded here: an external runtime’s plugin reads the registrations in this directory and dials the clients whose placement says the runtime is already resident (external).

Implementations

impl RegistrationFile

pub fn server(root: &Path) -> Self

This process serving root as a server root.

pub fn client(root: &Path) -> Self

This process serving root as a role workspace’s client daemon.

pub fn new(kind: RegistrationKind, root: &Path) -> Self

This process, WIRE_VERSION, canonical root, no role, no runtime.

pub fn with_role(self, role: impl Into<String>) -> Self

Name the role this registration serves.

pub fn with_runtime(self, runtime: impl Into<String>) -> Self

Name the runtime hosting the role’s sessions.

pub fn with_placement(self, placement: impl Into<String>) -> Self

Name the placement this machine displays the role’s sessions in.

Trait Implementations

impl Clone for RegistrationFile

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RegistrationFile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RegistrationFile

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for RegistrationFile

impl PartialEq for RegistrationFile

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for RegistrationFile

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 RegistrationFile