Struct StringMatchesCtx

pub struct StringMatchesCtx<'a> {
    pub regex_caches: &'a mut RegexCaches,
    pub exclusion_check: &'a ExclusionCheck<'a>,
    pub excluded_matches: &'a mut AHashSet<String>,
    pub match_emitter: &'a mut dyn MatchEmitter,
    pub wildcard_indices: Option<&'a Vec<(usize, usize)>>,
    pub per_string_data: &'a mut SharedData,
    pub per_scanner_data: &'a SharedData,
    pub per_event_data: &'a mut SharedData,
    pub event_id: Option<&'a str>,
    /* private fields */
}

Fields

regex_caches: &'a mut RegexCaches

exclusion_check: &'a ExclusionCheck<'a>

excluded_matches: &'a mut AHashSet<String>

match_emitter: &'a mut dyn MatchEmitter

wildcard_indices: Option<&'a Vec<(usize, usize)>>

per_string_data: &'a mut SharedData

per_scanner_data: &'a SharedData

per_event_data: &'a mut SharedData

event_id: Option<&'a str>

Implementations

impl StringMatchesCtx<'_>

pub fn process_async( &self, func: impl for<'a> FnOnce(&'a mut AsyncStringMatchesCtx) -> Pin<Box<dyn Future<Output = Result<(), ScannerError>> + Send + 'a>> + Send + 'static, ) -> RuleResult

If a get_string_matches implementation needs to do any async processing (e.g. I/O), this function can be used to return an “async job” to find matches. The return value of process_async should be returned from the get_string_matches function. The future passed into this function will be spawned and executed immediately without blocking other get_string_matches calls. This means all the async jobs will run concurrently.

The ctx available to async jobs is more restrictive than the normal ctx available in get_string_matches. The only thing you can do is return matches. If other data is needed, it should be accessed before process_async is called.