Skip to main content

PatternLine

Struct PatternLine 

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

Helper struct that permits to transform a template line with patterns into an instantiated line from a match.

Useful when you permit the user to reconstruct lines from an action, like in reaction’s native actions and in the virtual plugin:

actions:
  native:
    cmd: ["iptables", "...", "<ip>"]

  virtual:
    type: virtual
    options:
      send: "<ip>: bad password on user <user>"
      to: "my_virtual_stream"

Usage example:

let template = "<ip>: bad password on user <user>".to_string();
let patterns = vec!["ip".to_string(), "user".to_string()];
let pattern_line = PatternLine::new(template, patterns);

assert_eq!(
  pattern_line.line(vec!["1.2.3.4".to_string(), "root".to_string()]),
  "1.2.3.4: bad password on user root".to_string(),
);

You can find full examples in those plugins: reaction-plugin-virtual, reaction-plugin-cluster.

Implementations§

Source§

impl PatternLine

Source

pub fn new(template: String, patterns: Vec<String>) -> Self

Construct PatternLine from a template line and the list of patterns of the underlying Filter.

This list of patterns comes from super::ActionConfig.

Source

pub fn line(&self, match_: Vec<String>) -> String

Trait Implementations§

Source§

impl Debug for PatternLine

Source§

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

Formats the value using the given formatter. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more