Struct PlumbingRules 

pub struct PlumbingRules { /* private fields */ }

An ordered list of plumbing rules to use whenever something is “loaded” within the editor.

Implementations

impl PlumbingRules

pub fn try_load() -> Result<Self, String>

Attempt to load plumbing rules from the default location

pub fn plumb(&mut self, msg: PlumbingMessage) -> Option<MatchOutcome>

Run the provided message through the plumbing rules to determine how it should be handled. If no rules match then None is returned and default handling for a load takes place instead. The returned message may differ from the one passed in if rules carry out rewrites.

Trait Implementations

impl Debug for PlumbingRules

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

Formats the value using the given formatter.

impl Default for PlumbingRules

fn default() -> PlumbingRules

Returns the “default value” for a type.

impl FromStr for PlumbingRules

type Err = String

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for PlumbingRules

fn eq(&self, other: &PlumbingRules) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for PlumbingRules

impl StructuralPartialEq for PlumbingRules