Enum LockSuggestion 

pub enum LockSuggestion {
    UseAtomic {
        field: String,
        current_type: Option<String>,
        suggested_type: String,
        line: u32,
    },
    SplitLock {
        lock_name: String,
        suggested_splits: Vec<(String, String)>,
        line: u32,
    },
    ReduceScope {
        guard_name: String,
        current_span: (u32, u32),
        suggested_span: (u32, u32),
        reason: String,
    },
    UseRwLock {
        lock_name: String,
        read_count: usize,
        write_count: usize,
        line: u32,
    },
    LockAcrossAwait {
        guard_name: String,
        lock_line: u32,
        await_line: u32,
    },
    RemoveLock {
        lock_name: String,
        reason: String,
        line: u32,
    },
}

Suggestion for lock optimization.

Variants

UseAtomic

Field can be extracted to atomic type.

Fields

field: String

Field name.

current_type: Option<String>

Current type (if known).

suggested_type: String

Suggested atomic type.

line: u32

Line reference.

SplitLock

Lock can be split into multiple finer locks.

Fields

lock_name: String

Original lock variable.

suggested_splits: Vec<(String, String)>

Fields that can be split. (field_name, suggested_wrapper)

line: u32

Line reference.

ReduceScope

Critical section scope can be reduced.

Fields

guard_name: String

Guard variable name.

current_span: (u32, u32)

Current critical section lines.

suggested_span: (u32, u32)

Suggested narrower span.

reason: String

Reason for suggestion.

UseRwLock

Mutex can be replaced with RwLock.

Fields

lock_name: String

Lock variable name.

read_count: usize

Number of read accesses.

write_count: usize

Number of write accesses.

line: u32

Line reference.

LockAcrossAwait

Lock is held across await point.

Fields

guard_name: String

Guard variable name.

lock_line: u32

Lock acquisition line.

await_line: u32

Await point line.

RemoveLock

Lock can be removed (data is thread-local).

Fields

lock_name: String

Lock variable name.

reason: String

Reason.

line: u32

Line reference.

Implementations

impl LockSuggestion

pub fn severity(&self) -> u8

Get the severity/priority of this suggestion (higher = more important).

pub fn description(&self) -> String

Get a human-readable description.

pub fn short_description(&self) -> String

Get a short description for the suggestion.

Trait Implementations

impl Clone for LockSuggestion

fn clone(&self) -> LockSuggestion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LockSuggestion

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

Formats the value using the given formatter.

impl PartialEq for LockSuggestion

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

impl StructuralPartialEq for LockSuggestion