Struct ToolMetadata 

pub struct ToolMetadata {
    pub name: String,
    pub summary: String,
    pub description: String,
    pub release_source: Option<ReleaseSource>,
    pub update_policy: UpdatePolicy,
    pub update_check_interval: Duration,
    pub release_credential: Option<CredentialRef>,
    pub help: HelpChannel,
    pub update_public_keys: Vec<[u8; 32]>,
    pub update_checksums_asset: Option<&'static str>,
    pub update_asset_pattern: Option<&'static str>,
    pub telemetry_notice: Option<&'static str>,
}

Static tool metadata set at construction time.

Use the bon::Builder interface — name and summary are required at compile time; missing either is a compile error.

Fields

name: String

Human- and machine-facing tool name (mytool).

summary: String

One-line summary used in --help and the CLI banner.

description: String

Long-form description shown under --help.

release_source: Option<ReleaseSource>

Optional release source — required iff Feature::Update is runtime-enabled.

update_policy: UpdatePolicy

Author-set self-update policy baseline. Default UpdatePolicy::Disabled. In v0.1 the effective policy is this baseline (a runtime config override is deferred — see the spec). Inert unless Feature::Update is enabled and release_source is set.

update_check_interval: Duration

Minimum interval between automatic update checks (default 24h). Only consulted when update_policy is Prompt/Enabled; a check within this window of the last is throttled (skipped).

release_credential: Option<CredentialRef>

Optional credential reference for the release source. Resolved at update time via rtb_credentials::Resolver. Public repos don’t need it; private repos require this OR a fallback env var the resolver knows about.

Deserialised from config files but never serialised back — CredentialRef contains a SecretString literal that should not round-trip through Serialize (the secrecy crate removed the Serialize impl on purpose, mirroring the “secrets don’t cross untyped boundaries” rule).

help: HelpChannel

Support channel advertised in error diagnostic footers.

update_public_keys: Vec<[u8; 32]>

Ed25519 public keys trusted for verifying release-asset signatures. Multiple keys enable rotation without breaking already-deployed binaries — a release signed by a rotated-in key verifies against any binary whose trusted list includes that key. Empty means rtb-update refuses to run (see UpdateError::NoPublicKey). Not serialised — keys are compile-time constants, not config-file values.

update_checksums_asset: Option<&'static str>

Optional asset name listing SHA-256 checksums for this release. rtb-update downloads it alongside the binary and cross-checks the binary’s hash before swap. When None, signature verification is the only integrity gate.

update_asset_pattern: Option<&'static str>

Asset-name template rtb-update uses to select the right artefact for the running host. Default: {name}-{version}-{target}{ext}. Placeholders: {name} → ToolMetadata::name, {version} → release tag (leading v stripped), {target} → Rust host triple, {ext} → .tar.gz on Unix / .zip on Windows. Tools with a different naming convention set this explicitly.

telemetry_notice: Option<&'static str>

Privacy notice printed by rtb-cli’s v0.4 telemetry enable subcommand. None falls back to a generic message. Lives on ToolMetadata rather than rtb-telemetry so the subcommand can read it without depending on the telemetry crate.

Implementations

impl ToolMetadata

pub fn builder() -> ToolMetadataBuilder

Create an instance of ToolMetadata using the builder syntax

Trait Implementations

impl Clone for ToolMetadata

fn clone(&self) -> ToolMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolMetadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolMetadata

fn deserialize<__D>( __deserializer: __D, ) -> Result<ToolMetadata, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ToolMetadata

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

where __S: Serializer,

Serialize this value into the given Serde serializer.