Struct feattle::BackgroundSync
source · [−]pub struct BackgroundSync<F> { /* private fields */ }
Expand description
Spawn a tokio task to poll Feattles::reload()
continuously
A feattles instance will only ask the persistence layer for the current values when the
Feattles::reload()
method is called. This type would do so regularly for you, until the
Feattles
instance is dropped.
Example
use feattle_core::{feattles, Feattles};
use feattle_sync::BackgroundSync;
use feattle_core::persist::NoPersistence;
use std::sync::Arc;
feattles! {
struct MyToggles {
a: bool,
}
}
// `NoPersistence` here is just a mock for the sake of the example
let toggles = Arc::new(MyToggles::new(NoPersistence));
BackgroundSync::new(&toggles).spawn();
Implementations
sourceimpl<F> BackgroundSync<F>
impl<F> BackgroundSync<F>
sourcepub fn new(feattles: &Arc<F>) -> BackgroundSync<F>
pub fn new(feattles: &Arc<F>) -> BackgroundSync<F>
Create a new poller for the given feattles instance. It will call Arc::downgrade()
to
detect when the value is dropped.
sourcepub fn interval(&mut self, value: Duration) -> &mut BackgroundSync<F>
pub fn interval(&mut self, value: Duration) -> &mut BackgroundSync<F>
Set both Self::ok_interval
and Self::err_interval
sourcepub fn ok_interval(&mut self, value: Duration) -> &mut BackgroundSync<F>
pub fn ok_interval(&mut self, value: Duration) -> &mut BackgroundSync<F>
After a successful reload, will wait for this long before starting the next one. By default this is 30 seconds.
sourcepub fn err_interval(&mut self, value: Duration) -> &mut BackgroundSync<F>
pub fn err_interval(&mut self, value: Duration) -> &mut BackgroundSync<F>
After a failed reload, will wait for this long before starting the next one. By default this is 60 seconds.
sourcepub fn spawn<P>(self) -> JoinHandle<()> where
F: 'static + Feattles<P> + Sync + Send,
P: 'static + Persist + Sync,
pub fn spawn<P>(self) -> JoinHandle<()> where
F: 'static + Feattles<P> + Sync + Send,
P: 'static + Persist + Sync,
Spawn a new tokio task, returning its handle. Usually you do not want to anything with the returned handle, since the task will run by itself until the feattles instance gets dropped.
Operational logs are generated with the crate [log
].
Trait Implementations
Auto Trait Implementations
impl<F> RefUnwindSafe for BackgroundSync<F> where
F: RefUnwindSafe,
impl<F> Send for BackgroundSync<F> where
F: Send + Sync,
impl<F> Sync for BackgroundSync<F> where
F: Send + Sync,
impl<F> Unpin for BackgroundSync<F>
impl<F> UnwindSafe for BackgroundSync<F> where
F: RefUnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more