Skip to main content

RuleStore

Struct RuleStore 

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

Loader and watcher for per-machine tower rule files.

Rules live in <rules_dir>/*.yaml (or .yml / .json). The store is stateless — call load_all at boot and watch to receive subsequent changes.

Implementations§

Source§

impl RuleStore

Source

pub fn new(rules_dir: impl Into<PathBuf>) -> Self

Source

pub fn rules_dir(&self) -> &Path

Source

pub fn load_all(&self) -> LoadResult

Load all rule files from the rules directory.

Non-rule files (wrong extension) are silently ignored. Files that fail parsing, validation, or version checks are collected in skipped. I/O errors reading the directory are logged and an empty result returned.

Source

pub fn load_file( &self, path: &Path, ) -> Result<(TowerRule, Vec<RuleWarning>), SkipReason>

Parse and validate a single rule file.

YAML and JSON are both accepted. The schema version is probed before full deserialisation so that future-version files produce a SkipReason::FutureVersion rather than a serde unknown-variant error.

Source

pub fn watch(&self) -> Result<(RuleWatcher, Receiver<WatchEvent>), Error>

Start a config-file watcher on the rules directory.

Returns a RuleWatcher handle (keep alive for as long as watching is desired) and a mpsc::Receiver<WatchEvent> for consuming events.

The watcher translates notify events into WatchEvents on a background thread. The thread exits when the watcher handle is dropped (channel close).

Trait Implementations§

Source§

impl Clone for RuleStore

Source§

fn clone(&self) -> RuleStore

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.