Struct ServiceDef 

pub struct ServiceDef {
    pub service: ServiceMeta,
    pub requirements: Option<Requirements>,
    pub ports: Vec<PortDef>,
    pub env: Vec<EnvVar>,
    pub env_groups: Vec<EnvGroup>,
    pub choices: Vec<Choice>,
    pub requires: Vec<ServiceRequirement>,
    pub mappings: Mappings,
    pub integrations: IntegrationFlags,
    pub capabilities: Capabilities,
    pub backup: Option<BackupConfig>,
    pub metrics: Option<MetricsDef>,
}

A service definition from a registry’s services/<name>/service.toml.

Fields

service: ServiceMeta

requirements: Option<Requirements>

ports: Vec<PortDef>

env: Vec<EnvVar>

env_groups: Vec<EnvGroup>

Optional, user-toggled bundles of env vars. A group is either fully enabled (every member lands in .env) or fully disabled (none do) — makes “client_id without client_secret” unrepresentable.

choices: Vec<Choice>

Mutually-exclusive choices. Exactly one option per choice is selected and only that option’s env vars are written, so “none selected” and “two at once” are unrepresentable rather than rejected. The sum type to env_group’s product.

requires: Vec<ServiceRequirement>

mappings: Mappings

integrations: IntegrationFlags

capabilities: Capabilities

Roles this service can play for other services. The dual of IntegrationFlags (which describes what this service consumes). Drives capability-based dispatch — see crate::capability.

backup: Option<BackupConfig>

Backup configuration. Present only when the author has declared backup = true in [integrations] and the service needs more than the default “back up everything classified as data.” Carries hooks (pre/post dump) and exclude lists.

metrics: Option<MetricsDef>

Prometheus-style metrics endpoint this service exposes. When set and a metrics-store provider is installed, ryra writes a file_sd scrape target and joins the service to the store’s network.

Implementations

impl ServiceDef

pub fn check_architecture(&self) -> Option<String>

Check if this service supports the current system architecture. Returns None if supported (or no restriction), Some(error) if not.

pub fn required_env_vars(&self) -> Vec<&str>

Returns env var names that are required — must be provided during install.

pub fn validate(&self) -> Result<(), String>

Validate structural invariants that serde can’t enforce. Called once after deserialization — if this returns Ok, the definition is safe to use without further checks.

Trait Implementations

impl Clone for ServiceDef

fn clone(&self) -> ServiceDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServiceDef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ServiceDef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ServiceDef

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

where __S: Serializer,

Serialize this value into the given Serde serializer.