Skip to main content

UpdateCheckHandler

Struct UpdateCheckHandler 

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

TaskHandler that polls the GitHub releases API for a newer Zeph version.

On each execution, UpdateCheckHandler fetches the latest release from https://api.github.com/repos/bug-ops/zeph/releases/latest, compares the tag_name field against current_version using semantic versioning, and sends a human-readable notification message on notify_tx when a newer release is found.

Network and parse errors are logged as warnings; execute always returns Ok(()) so a transient failure does not stop the scheduler.

§Examples

use tokio::sync::mpsc;
use zeph_scheduler::UpdateCheckHandler;

let (tx, mut rx) = mpsc::channel(1);
let handler = UpdateCheckHandler::new(env!("CARGO_PKG_VERSION"), tx);

use zeph_scheduler::TaskHandler;
handler
    .execute(&serde_json::Value::Null)
    .await
    .expect("update check should not fail");

// A notification is sent only when a newer version exists on GitHub.
if let Ok(msg) = rx.try_recv() {
    println!("{msg}");
}

Implementations§

Source§

impl UpdateCheckHandler

Source

pub fn new(current_version: &'static str, notify_tx: Sender<String>) -> Self

Create a new handler.

current_version should be env!("CARGO_PKG_VERSION"). Notifications are sent as formatted strings via notify_tx.

§Panics

Panics if the underlying reqwest client cannot be constructed (unreachable in practice).

Source

pub fn with_base_url(self, url: impl Into<String>) -> Self

Override the GitHub releases API URL.

Intended for tests only: point the handler at a local mock server so the test does not make real network requests.

Trait Implementations§

Source§

impl TaskHandler for UpdateCheckHandler

Source§

fn execute( &self, _config: &Value, ) -> Pin<Box<dyn Future<Output = Result<(), SchedulerError>> + Send + '_>>

Execute the task with the provided configuration. Read more

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<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