Struct SearchScope 

pub struct SearchScope {

    pub query: Option<Query>,
    pub mem: Option<String>,
    pub entity_type: Option<String>,
    pub limit: Option<usize>,
    pub offset: Option<usize>,
    pub filters: HashMap<String, String>,
    pub range_filters: HashMap<String, String>,
    pub edge_type: Option<String>,
    pub related_to: Option<EntityId>,
    pub depth: Option<usize>,
    pub expand_via: Option<Vec<String>>,
    pub expand_depth: Option<usize>,
    pub direction: TraversalDirection,
    pub stub: Option<bool>,
    pub token_budget: Option<usize>,
}

Scope filters for search and list operations.

Fields

query: Option<Query>

Structured flat query. All text matching flows through this field; see Query for semantics. None (or an empty query) makes search behave as a metadata-only filter.

mem: Option<String>

entity_type: Option<String>

limit: Option<usize>

offset: Option<usize>

filters: HashMap<String, String>

Equality filters on metadata fields: { "level": "M0" }.

range_filters: HashMap<String, String>

Range filters: { "min_coverage": "0.5", "max_coverage": "1.0" }.

edge_type: Option<String>

Only entities with this edge type (incoming or outgoing).

related_to: Option<EntityId>

Only entities reachable from this entity within depth hops.

depth: Option<usize>

expand_via: Option<Vec<String>>

Relationship types to follow from primary hits to pull in graph-proximal neighbours.

expand_depth: Option<usize>

Maximum hops to traverse via expand_via (default: 1 when expand_via is set).

direction: TraversalDirection

Traversal direction for related_to AND expand_via, applied at EVERY hop (depth > 1 is a pure transitive closure in the chosen direction, never a mixed walk). Defaults to both — the historical undirected behaviour, so a query omitting the selector returns exactly what it always returned.

stub: Option<bool>

Filter by stub status. None = no filter (returns both stubs and real entities); Some(true) = only stubs; Some(false) = only real entities.

token_budget: Option<usize>

Token budget bounding the returned hit payload (search path only). None uses the engine default. A page whose hits exceed the budget is greedily trimmed (at least one hit always returns) with a SEARCH_RESULTS_TRUNCATED warning; total still reflects the full match count so the agent can page with offset.

Trait Implementations

impl Clone for SearchScope

fn clone(&self) -> SearchScope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchScope

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

Formats the value using the given formatter.

impl Default for SearchScope

fn default() -> SearchScope

Returns the “default value” for a type.