Struct SymbolFilter 

pub struct SymbolFilter {
    pub path_prefix: Option<String>,
    pub kind: Option<SymbolKind>,
    pub name_contains: Option<String>,
}

A conjunctive filter for GraphStore::list — every set field must match. All fields unset matches every symbol.

Fields

path_prefix: Option<String>

kind: Option<SymbolKind>

name_contains: Option<String>

Implementations

impl SymbolFilter

pub fn path_prefix(self, prefix: impl Into<String>) -> Self

Restrict to symbols whose path starts with prefix (scopes to a crate or directory).

pub fn kind(self, kind: SymbolKind) -> Self

Restrict to one SymbolKind.

pub fn name_contains(self, needle: impl Into<String>) -> Self

Restrict to symbols whose name contains needle.

pub fn matches(&self, located: &Located<Symbol>) -> bool

Whether located satisfies every set field.

Trait Implementations

impl Clone for SymbolFilter

fn clone(&self) -> SymbolFilter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SymbolFilter

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

Formats the value using the given formatter.

impl Default for SymbolFilter

fn default() -> SymbolFilter

Returns the “default value” for a type.

impl PartialEq for SymbolFilter

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

impl StructuralPartialEq for SymbolFilter