Skip to main content

RuleHeader

Struct RuleHeader 

Source
pub struct RuleHeader {
    pub rule_title: String,
    pub rule_id: Option<String>,
    pub level: Option<Level>,
    pub tags: Vec<String>,
    pub custom_attributes: Arc<HashMap<String, Value>>,
    pub enrichments: Option<Map<String, Value>>,
}
Expand description

Fields shared between detection and correlation results.

The optional enrichments map is None for results emitted directly by the engine; downstream middleware can populate it with arbitrary JSON values to ride along with each result.

Fields§

§rule_title: String

Title of the matched rule.

§rule_id: Option<String>

ID of the matched rule (if present).

§level: Option<Level>

Severity level.

§tags: Vec<String>

Tags from the matched rule.

§custom_attributes: Arc<HashMap<String, Value>>

Custom attributes from the rule (merged with pipeline overrides).

Wrapped in Arc so per-match cloning is a pointer bump.

§enrichments: Option<Map<String, Value>>

Optional map of arbitrary enrichment values, written by downstream middleware. None for engine-emitted results; skipped on serialize.

Trait Implementations§

Source§

impl Clone for RuleHeader

Source§

fn clone(&self) -> RuleHeader

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
Source§

impl Debug for RuleHeader

Source§

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

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

impl Serialize for RuleHeader

Source§

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

Serialize this value into the given Serde serializer. 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.