Struct Ruler

Source
pub struct Ruler<M, T> { /* private fields */ }
Expand description

Ruler allows you to implement a plugin system with dependency management and ensure that your dependencies are called in the correct order.

You can use it like this:

use markdown_that::common::ruler::Ruler;

// this example prints "[ hello, world! ]",
// where each token is printed by a separate closure
let mut chain = Ruler::<&str, fn (&mut String)>::new();

// define rules printing "hello" and "world"
chain.add("hello", |s| s.push_str("hello"));
chain.add("world", |s| s.push_str("world"));

// an open bracket should be before "hello" and closing one after "world"
chain.add("open_bracket", |s| s.push_str("[ ")).before("hello");
chain.add("close_bracket", |s| s.push_str(" ]")).after("world");

// between "hello" and "world" we shall have a comma
chain.add("comma", |s| s.push_str(", ")).after("hello").before("world");

// after "world" we should have "!" as a first rule, but ensure "world" exists first
chain.add("bang", |s| s.push_str("!")).require("world").after("world").before_all();

// now we run this chain
let mut result = String::new();
for f in chain.iter() { f(&mut result); }
assert_eq!(result, "[ hello, world! ]");

This data structure contains any number of elements (M, T), where T is any type and M (mark) is its identifier.

  • M is used for ordering and dependency checking, it must implement Eq + Copy + Hash + Debug. Common choices for Mareu32, &’static str, or a special Symbol` type designed for this purpose.

  • T is any user-defined type. It’s usually a function or boxed trait.

Implementations§

Source§

impl<M, T> Ruler<M, T>

Source

pub fn new() -> Self

Source§

impl<M: Eq + Hash + Copy + Debug, T: Clone> Ruler<M, T>

Source

pub fn add(&mut self, mark: M, value: T) -> &mut RuleItem<M, T>

Add a new rule identified by mark with payload value.

Source

pub fn remove(&mut self, mark: M)

Remove all rules identified by mark.

Source

pub fn contains(&mut self, mark: M) -> bool

Check if there are any rules identified by mark.

Source

pub fn iter(&self) -> Iter<'_, T>

Ordered iteration through rules.

Trait Implementations§

Source§

impl<M: Eq + Hash + Copy + Debug, T: Clone> Debug for Ruler<M, T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<M, T> Default for Ruler<M, T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<M, T> !Freeze for Ruler<M, T>

§

impl<M, T> RefUnwindSafe for Ruler<M, T>

§

impl<M, T> Send for Ruler<M, T>
where T: Send, M: Send,

§

impl<M, T> Sync for Ruler<M, T>
where T: Sync + Send, M: Sync,

§

impl<M, T> Unpin for Ruler<M, T>
where T: Unpin, M: Unpin,

§

impl<M, T> UnwindSafe for Ruler<M, T>
where T: UnwindSafe, M: UnwindSafe,

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Send + Sync>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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, 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> ErasedDestructor for T
where T: 'static,