Struct FunctionSpec 

pub struct FunctionSpec {
    pub name: String,
    pub role: Option<Role>,
    pub pure: Option<bool>,
    pub noreturn: Option<bool>,
    pub disabled: Option<bool>,
    pub params: Vec<ParamSpec>,
    pub returns: Option<ReturnSpec>,
    pub taint: Option<TaintSpec>,
}

A function specification describing external/library function behavior.

All fields are optional except name. Analyses use safe defaults when fields are missing. See the design doc for default behavior per field.

Fields

name: String

Function name or pattern. Use glob: or regex: prefix for pattern matching.

role: Option<Role>

High-level role of this function (e.g., allocator, source, sink).

pure: Option<bool>

Function has no side effects; result depends only on inputs.

noreturn: Option<bool>

Function never returns (e.g., exit, abort, longjmp).

disabled: Option<bool>

Suppress an inherited spec from a lower-priority source.

params: Vec<ParamSpec>

Per-parameter specifications.

returns: Option<ReturnSpec>

Return value specification.

taint: Option<TaintSpec>

Taint propagation rules.

Implementations

impl FunctionSpec

pub fn new(name: impl Into<String>) -> Self

Create a new minimal spec with just a name.

pub fn is_disabled(&self) -> bool

Check if this spec is disabled.

pub fn is_pure(&self) -> bool

Check if function is pure (no side effects).

pub fn is_noreturn(&self) -> bool

Check if function never returns.

pub fn param(&self, index: u32) -> Option<&ParamSpec>

Get the spec for a specific parameter by index.

pub fn merge(&mut self, other: &FunctionSpec)

Merge another spec into this one (other overrides self for present fields).

Trait Implementations

impl Clone for FunctionSpec

fn clone(&self) -> FunctionSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FunctionSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FunctionSpec

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

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 FunctionSpec