Struct Scope 

pub struct Scope { /* private fields */ }

Which fields of an event a rule looks at.

A scope starts with the include fields (either everything or a list of specific paths), then exclude prevents some of those from being scanned. exclude is useful when scanning everything except a few fields, or when including some fields but not some of their children.

A path covers itself and all of its children. When a field is covered by both include and exclude, exclude wins, even if the include path is more specific.

Excluded fields never produce a match. Regex rules may still scan them internally for multipass V0, which uses the values found there to drop identical matches elsewhere in the event as false positives.

Implementations

impl Scope

pub fn all() -> Self

Covers every field of the event.

pub fn include_and_exclude( include: Vec<Path<'static>>, exclude: Vec<Path<'static>>, ) -> Self

Covers fields under any include path, minus fields under any exclude path.

pub fn include(include: Vec<Path<'static>>) -> Self

Covers only fields under any include path. An empty include means the rule never runs.

pub fn exclude(exclude: Vec<Path<'static>>) -> Self

Covers every field, minus fields under any exclude path.

Trait Implementations

impl Clone for Scope

fn clone(&self) -> Scope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Scope

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

Formats the value using the given formatter.

impl Default for Scope

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Scope

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Scope

fn eq(&self, other: &Scope) -> 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 Serialize for Scope

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Scope