Struct DaemonId 

pub struct DaemonId { /* private fields */ }

A structured daemon identifier consisting of a namespace and a name.

All daemons have a namespace - global daemons use “global” as their namespace. This type eliminates the need to repeatedly parse and format daemon IDs.

Formats

• Qualified format: namespace/name (e.g., project-a/api, global/web)
• Safe path format: namespace--name (for filesystem paths)

Examples

use pitchfork_cli::daemon_id::DaemonId;

let id = DaemonId::try_new("project-a", "api").unwrap();
assert_eq!(id.namespace(), "project-a");
assert_eq!(id.name(), "api");
assert_eq!(id.qualified(), "project-a/api");
assert_eq!(id.safe_path(), "project-a--api");

Implementations

impl DaemonId

pub fn try_new( namespace: impl Into<String>, name: impl Into<String>, ) -> Result<Self>

Creates a new DaemonId with validation.

Returns an error if either the namespace or name is invalid.

pub fn parse(s: &str) -> Result<Self>

Parses a qualified daemon ID string into a DaemonId.

The input must be in the format namespace/name.

Examples

use pitchfork_cli::daemon_id::DaemonId;

let id = DaemonId::parse("project-a/api").unwrap();
assert_eq!(id.namespace(), "project-a");
assert_eq!(id.name(), "api");

pub fn from_safe_path(s: &str) -> Result<Self>

Creates a DaemonId from a filesystem-safe path component.

Converts namespace--name format back to a DaemonId. Both components are validated with the same rules as try_new(), ensuring that the result can always be serialized and deserialized through the qualified (namespace/name) format without error.

Examples

use pitchfork_cli::daemon_id::DaemonId;

let id = DaemonId::from_safe_path("project-a--api").unwrap();
assert_eq!(id.qualified(), "project-a/api");
assert_eq!(DaemonId::parse(&id.qualified()).unwrap(), id);

// Empty namespace or name fails validation
assert!(DaemonId::from_safe_path("--api").is_err());
assert!(DaemonId::from_safe_path("namespace--").is_err());
// Namespace containing "--" is rejected to preserve roundtrip
assert!(DaemonId::from_safe_path("my--project--api").is_err());

pub fn namespace(&self) -> &str

Returns the namespace portion of the daemon ID.

pub fn pitchfork() -> Self

Returns a DaemonId for the pitchfork supervisor itself.

This is a convenience method to avoid repeated DaemonId::new("global", "pitchfork") calls.

pub fn name(&self) -> &str

Returns the name (short ID) portion of the daemon ID.

pub fn qualified(&self) -> String

Returns the qualified format: namespace/name.

pub fn safe_path(&self) -> String

Returns the filesystem-safe format: namespace--name.

pub fn log_path(&self) -> PathBuf

Returns the main log file path for this daemon.

pub fn styled_display_name<'a, I>(&self, all_ids: Option<I>) -> String

where I: Iterator<Item = &'a DaemonId>,

Returns a styled display name for terminal output (stdout).

The namespace part is displayed in dim color, followed by / and the name. If all_ids is provided and the name is unique, only the name is shown.

pub fn styled_qualified(&self) -> String

Returns the qualified format with dim namespace for terminal output (stdout).

Format: <dim>namespace</dim>/name

Trait Implementations

impl Clone for DaemonId

fn clone(&self) -> DaemonId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DaemonId

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

Formats the value using the given formatter.

impl Default for DaemonId

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DaemonId

Deserialize from qualified string “namespace/name”

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DaemonId

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

Formats the value using the given formatter.

impl Hash for DaemonId

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 JsonSchema for DaemonId

JSON Schema implementation for DaemonId

In pitchfork.toml, users write short names (e.g. api) for daemon keys under [daemons] and for same-namespace depends entries. Fully qualified namespace/name format is only required for cross-namespace dependency references. The pattern therefore accepts both forms.

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(_gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Ord for DaemonId

fn cmp(&self, other: &DaemonId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for DaemonId

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

fn partial_cmp(&self, other: &DaemonId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for DaemonId

Serialize as qualified string “namespace/name”

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for DaemonId

impl StructuralPartialEq for DaemonId