Struct CertificateWatcher

pub struct CertificateWatcher {
    sources: Vec<CertificateSource>,
    default_source: DefaultCertificateSource,
    files_watcher: RecommendedWatcher,
    files_rx: Receiver<Event>,
    config_rx: Receiver<CertConfigUpdate>,
    config_tx: Sender<CertConfigUpdate>,
}

A watcher for updates to certificate sources

Fields

sources: Vec<CertificateSource>

All currently-watched non-default certificate sources

default_source: DefaultCertificateSource

The default certificate source

files_watcher: RecommendedWatcher

Underlying watcher for certificates read from files

files_rx: Receiver<Event>

Receiver for file modification events from files_watcher

config_rx: Receiver<CertConfigUpdate>

Receiver for certificate source configuration updates

config_tx: Sender<CertConfigUpdate>

Sender for certificate source configuration updates, can be retrieved using Self::get_config_sender().

Implementations

impl CertificateWatcher

pub fn new() -> Result<Self>

Create a new CertificateWatcher

Errors

This function returns an error if the file watcher for files certificate sources could not be set up

pub fn watch( &mut self, debounce_time: Duration, ) -> (Vec<CertificateSource>, DefaultCertificateSource)

Watch for changes to the certificates

Blocks until a change has occurred, returning all CertificateSources that have changed and need to be reloaded. The first element in the tuple contains all updated sources from certificates, the second is the default certificate source (or None if it hasn’t been updated). May return multiple certificate sources at once if one event caused all of them to need updating. May return a false positive (a certificate source may be returned when it hasn’t actually changed).

pub fn get_config_sender(&self) -> Sender<CertConfigUpdate>

Get the sender for certificate source configuration updates

pub fn send_config_update(&self, update: CertConfigUpdate)

Send a config update to be processed by this watcher

Trait Implementations

impl Debug for CertificateWatcher

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

Formats the value using the given formatter.