Skip to main content

SigmaString

Struct SigmaString 

Source
pub struct SigmaString {
    pub parts: Vec<StringPart>,
    pub original: String,
}
Expand description

A Sigma string value that may contain wildcards.

When Sigma rules specify string values, * and ? are interpreted as wildcards unless escaped with \. This type preserves the structure so downstream consumers (evaluators, converters) can handle wildcards appropriately.

§Escape semantics

Backslash (\) is the escape character. Its behavior depends on what follows:

InputParsed asRationale
\*literal *Escapes the wildcard — backslash consumed
\?literal ?Escapes the wildcard — backslash consumed
\\literal \Escapes itself — backslash consumed
\Wliteral \W (both kept)Non-special char — backslash preserved

This matches the pySigma SigmaString behavior: backslash only consumes itself when followed by a Sigma-special character (*, ?, \). Before non-special characters it is treated as a literal backslash, which is important for patterns like \Windows\ in file paths.

Fields§

§parts: Vec<StringPart>§original: String

Implementations§

Source§

impl SigmaString

Source

pub fn new(s: &str) -> Self

Parse a string, interpreting * and ? as wildcards and \ as escape.

Source

pub fn from_raw(s: &str) -> Self

Create from a raw string with no wildcard parsing (e.g. for re modifier).

Source

pub fn is_plain(&self) -> bool

Returns true if the string contains no wildcards.

Source

pub fn contains_wildcards(&self) -> bool

Returns true if the string contains any wildcard characters.

Source

pub fn as_plain(&self) -> Option<String>

Get the plain string content (without wildcards). Returns None if wildcards present.

Trait Implementations§

Source§

impl Clone for SigmaString

Source§

fn clone(&self) -> SigmaString

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SigmaString

Source§

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

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

impl Display for SigmaString

Source§

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

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

impl PartialEq for SigmaString

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for SigmaString

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

impl Eq for SigmaString

Source§

impl StructuralPartialEq for SigmaString

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.