Struct ParamSpec 

pub struct ParamSpec {
    pub index: u32,
    pub name: Option<String>,
    pub modifies: Option<bool>,
    pub reads: Option<bool>,
    pub nullness: Option<Nullness>,
    pub escapes: Option<bool>,
    pub callback: Option<bool>,
    pub semantic: Option<String>,
    pub size_from: Option<String>,
    pub tainted: Option<bool>,
}

Per-parameter specification.

Fields

index: u32

Parameter position (0-indexed).

name: Option<String>

Optional human-readable name.

modifies: Option<bool>

Parameter’s pointee is modified.

reads: Option<bool>

Parameter’s pointee is read.

nullness: Option<Nullness>

Nullness requirement/guarantee.

escapes: Option<bool>

Pointer may escape function scope.

callback: Option<bool>

This is a function pointer that will be called.

semantic: Option<String>

Semantic meaning (e.g., allocation_size, byte_count).

size_from: Option<String>

Size bound relation (e.g., “param.2” for buffer size).

tainted: Option<bool>

Parameter becomes tainted after call (for sources).

Implementations

impl ParamSpec

pub fn new(index: u32) -> Self

Create a new param spec for the given index.

pub fn does_modify(&self) -> bool

Check if this parameter modifies its pointee.

pub fn does_read(&self) -> bool

Check if this parameter reads its pointee.

pub fn may_escape(&self) -> bool

Check if this parameter may escape.

pub fn is_callback(&self) -> bool

Check if this parameter is a callback.

fn merge(&mut self, other: &ParamSpec)

Merge another param spec into this one.

Trait Implementations

impl Clone for ParamSpec

fn clone(&self) -> ParamSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParamSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ParamSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ParamSpec

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

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 ParamSpec