Skip to main content

UpgradeMonitor

Struct UpgradeMonitor 

Source
pub struct UpgradeMonitor { /* private fields */ }
Expand description

Monitors GitHub releases for new versions.

Implementations§

Source§

impl UpgradeMonitor

Source

pub fn new( repo: String, channel: UpgradeChannel, check_interval_hours: u64, ) -> Self

Create a new upgrade monitor.

§Arguments
  • repo - GitHub repository in “owner/repo” format
  • channel - Release channel to track (Stable or Beta)
  • check_interval_hours - How often to check for updates
Source

pub fn with_release_cache(self, cache: ReleaseCache) -> Self

Configure a shared disk cache for release metadata.

When set, check_for_updates will consult the cache before hitting the GitHub API. Fresh results are written back so that other nodes on the same machine can reuse them.

Source

pub fn with_staged_rollout(self, node_id: &[u8], max_delay_hours: u64) -> Self

Configure staged rollout for this monitor.

§Arguments
  • node_id - The node’s unique identifier for deterministic delay calculation
  • max_delay_hours - Maximum rollout window (0 to disable)
Source

pub fn check_interval(&self) -> Duration

Get the check interval.

Source

pub fn current_version(&self) -> &Version

Get the current version.

Source

pub fn repo(&self) -> &str

Get the tracked repository.

Source

pub fn version_matches_channel(&self, version: &Version) -> bool

Check if version matches the configured channel.

  • Stable channel: Only accepts versions without pre-release suffixes
  • Beta channel: Accepts all versions (stable and pre-release)
Source

pub async fn check_for_updates(&self) -> Result<Option<UpgradeInfo>>

Check GitHub for available updates.

This method only checks for available updates, it does not respect staged rollout delays. Use Self::check_for_ready_upgrade for staged rollout aware upgrade checking.

§Errors

Returns an error if the GitHub API request fails.

Source

pub async fn check_for_ready_upgrade(&mut self) -> Result<Option<UpgradeInfo>>

Check for available updates with staged rollout awareness.

This method:

  1. Checks GitHub for available updates
  2. If staged rollout is enabled and an upgrade is found:
    • Starts tracking the upgrade detection time
    • Returns None until the calculated delay has passed
    • Returns the upgrade info once the node is ready to apply it
§Errors

Returns an error if the GitHub API request fails.

Source

pub fn time_until_upgrade(&self) -> Option<Duration>

Get the remaining time until this node should upgrade.

Returns None if no upgrade is pending or staged rollout is disabled.

Source

pub fn has_staged_rollout(&self) -> bool

Check if staged rollout is enabled.

Source

pub fn pending_version(&self) -> Option<&Version>

Get the pending upgrade version, if any.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more