Struct Cap 

pub struct Cap(/* private fields */);

Security capability bits for sources, sanitizers, and sinks.

Each bit represents a security-relevant property. The meaning depends on which role the Cap value is attached to:

• Source: which attack classes this tainted value can potentially trigger. Sources usually carry Cap::all() so they match any sink. ENV_VAR is an exception — it marks origin rather than reach.
• Sanitizer: which attack classes this function strips. A sanitizer labelled with HTML_ESCAPE clears the XSS-relevant bits from tainted values that flow through it.
• Sink: which capability bits must be present on the incoming tainted value for a finding to fire. A SQL sink requires SQL_QUERY.

In practice: a finding fires when a tainted value reaches a sink and (value_caps & sink_caps) != 0.

Implementations

impl Cap

pub const ENV_VAR: Self

Taint that originated from an environment variable read. Used as a source-origin marker for env-injection rules.

pub const HTML_ESCAPE: Self

Sanitizer: the value has passed through HTML entity escaping. Strips XSS risk from values that reach HTML output sinks.

pub const SHELL_ESCAPE: Self

Sanitizer: the value has been shell-argument escaped. Strips command-injection risk before shell sinks.

pub const URL_ENCODE: Self

Sanitizer: the value has been percent-encoded for use in a URL.

pub const JSON_PARSE: Self

Sanitizer: the value was parsed through a structured JSON decoder (as opposed to eval-based or regex parsing).

pub const FILE_IO: Self

Sink: file system read or write operation (path traversal, arbitrary file read/write).

pub const FMT_STRING: Self

Sink: format string injection (e.g. printf-family, String.format).

pub const SQL_QUERY: Self

Sink: SQL query construction. Fires for string-concatenated queries and parameterized-query builders where the query text itself is tainted.

pub const DESERIALIZE: Self

Sink: unsafe object deserialization (Java ObjectInputStream, Python pickle, Ruby Marshal, PHP unserialize, etc.).

pub const SSRF: Self

Sink: server-side request forgery. Fires when attacker-controlled data reaches the destination URL of an outbound HTTP request.

pub const CODE_EXEC: Self

Sink: code or command execution (shell injection, eval, exec, dynamic require/import, template injection).

pub const CRYPTO: Self

Sink: cryptographic operation with a tainted algorithm name or seed (weak-crypto / predictable-randomness patterns).

pub const UNAUTHORIZED_ID: Self

Request-bound, caller-supplied identifier that has not yet been validated against an ownership/membership check. Used as the carrier cap for folding auth_analysis into the SSA/taint engine.

pub const DATA_EXFIL: Self

Cross-boundary data-exfiltration: tainted sensitive data flowing into outbound request bodies, headers, or other payload-bearing fields of network egress APIs. Distinct from SSRF (attacker control over the destination URL), DATA_EXFIL fires when the destination is fixed but attacker-influenced data leaves the process via the request payload.

impl Cap

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u16

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u16) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u16) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u16) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in self are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: Self) -> bool

Whether any set bits in other are also set in self.

pub const fn contains(&self, other: Self) -> bool

Whether all set bits in other are also set in self.

pub fn insert(&mut self, other: Self)

The bitwise or (|) of the bits in self and other.

pub fn remove(&mut self, other: Self)

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in self and other.

pub fn set(&mut self, other: Self, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in self and other.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in self and other.

pub const fn difference(self, other: Self) -> Self

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in self and other.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

impl Cap

pub const fn iter(&self) -> Iter<Cap>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<Cap>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for Cap

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

Formats the value using the given formatter.

impl BitAnd for Cap

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in self and other.

type Output = Cap

The resulting type after applying the & operator.

impl BitAndAssign for Cap

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in self and other.

impl BitOr for Cap

fn bitor(self, other: Cap) -> Self

The bitwise or (|) of the bits in self and other.

type Output = Cap

The resulting type after applying the | operator.

impl BitOrAssign for Cap

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in self and other.

impl BitXor for Cap

fn bitxor(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in self and other.

type Output = Cap

The resulting type after applying the ^ operator.

impl BitXorAssign for Cap

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in self and other.

impl Clone for Cap

fn clone(&self) -> Cap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Cap

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

Formats the value using the given formatter.

impl Default for Cap

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Cap

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Extend<Cap> for Cap

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for Cap

const FLAGS: &'static [Flag<Cap>]

The set of defined flags.

type Bits = u16

The underlying bits type.

fn bits(&self) -> u16

Get the underlying bits value.

fn from_bits_retain(bits: u16) -> Cap

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn known_bits(&self) -> Self::Bits

Get the known bits from a flags value.

fn unknown_bits(&self) -> Self::Bits

Get the unknown bits from a flags value.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by Self::FLAGS.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in other are also set in self.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in other are also set in self.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in self and other.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of self with the complement of other (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in self and other.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in self and other.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in self and other.

fn difference(self, other: Self) -> Self

The intersection of self with the complement of other (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in self and other.

fn complement(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

impl FromIterator<Cap> for Cap

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

impl IntoIterator for Cap

type Item = Cap

The type of the elements being iterated over.

type IntoIter = Iter<Cap>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for Cap

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

Formats the value using the given formatter.

impl Not for Cap

fn not(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

type Output = Cap

The resulting type after applying the ! operator.

impl Octal for Cap

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

Formats the value using the given formatter.

impl PartialEq for Cap

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

type Primitive = u16

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Serialize for Cap

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Sub for Cap

fn sub(self, other: Self) -> Self

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = Cap

The resulting type after applying the - operator.

impl SubAssign for Cap

fn sub_assign(&mut self, other: Self)

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for Cap

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

Formats the value using the given formatter.

impl Copy for Cap

impl Eq for Cap

impl StructuralPartialEq for Cap