Enum PluginRole 

#[non_exhaustive]
pub enum PluginRole {
    DetectVersion,
    FetchReleases,
    ExecuteUpdate,
    PreUpdateHook,
    PostUpdateHook,
    Other(String),
}

Re-export PluginRole so consumers can construct and match on role values without a direct uptrakit-shared-types dependency. Roles that a plugin can fulfill in the version-check / update lifecycle.

Each (host_id, software_item_id) pair may have up to one plugin assignment per role, enabling mix-and-match plugin configurations (e.g., APT for detection, GitHub for release fetching).

Wire forward-compatibility

Other(String) is a catch-all variant for role strings received from a newer peer that this binary does not yet know about. Serde deserialization is infallible: an unknown string such as "pre_update_hook" becomes Other("pre_update_hook") rather than a parse error, allowing older agents and web-API clients to survive rolling upgrades without dropping entire messages.

FromStr retains its original error behaviour for known-role contexts (API validation, URL parameters, database columns) where a caller explicitly needs to distinguish known variants from unknown ones.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

DetectVersion

Detects the installed version on the agent host.

FetchReleases

Fetches the latest available version (controller-side for API plugins, agent-side for local package-index plugins).

ExecuteUpdate

Executes the actual software update on the agent host.

PreUpdateHook

Runs a lifecycle plugin before the update (ordered by ordinal).

PostUpdateHook

Runs a lifecycle plugin after the update (ordered by ordinal).

Other(String)

An unknown plugin role received from a newer peer.

The inner string is the raw snake_case value as it appeared on the wire.

Implementations

impl PluginRole

pub fn as_str(&self) -> &str

Returns the snake_case string representation of this plugin role.

For PluginRole::Other, returns the inner string as-is.

Trait Implementations

impl Clone for PluginRole

fn clone(&self) -> PluginRole

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PluginRole

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PluginRole

fn deserialize<D>( deserializer: D, ) -> Result<PluginRole, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PluginRole

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

Formats the value using the given formatter.

impl Eq for PluginRole

impl From<String> for PluginRole

fn from(s: String) -> PluginRole

Converts a snake_case string to a plugin role.

Unknown strings map to PluginRole::Other rather than failing.

impl FromStr for PluginRole

type Err = ParsePluginRoleError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<PluginRole, <PluginRole as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for PluginRole

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

where __H: Hasher,

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 PartialEq for PluginRole

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for PluginRole

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.

impl StructuralPartialEq for PluginRole