Skip to main content

Args

Struct Args 

Source
pub struct Args {
Show 20 fields pub text: Option<String>, pub mem: Option<String>, pub entity_type: Option<String>, pub field: Option<String>, pub exclude: Vec<String>, pub phrase: Option<String>, pub edge_type: Option<String>, pub related_to: Option<String>, pub depth: Option<usize>, pub limit: Option<usize>, pub offset: Option<usize>, pub level: Option<String>, pub status: Option<String>, pub filter: Vec<String>, pub range_filter: Vec<String>, pub expand_via: Vec<String>, pub expand_depth: Option<usize>, pub direction: DirectionArg, pub stub: bool, pub no_stub: bool,
}
Expand description

Find entities by text or graph proximity.

Fields§

§text: Option<String>

Free-text query. Omit for a pure structural filter.

§mem: Option<String>§entity_type: Option<String>§field: Option<String>

Restrict text matching to a single field (title or section key). Maps to Query.field — narrows any, not, and phrase for the query. Replaces the former repeatable plural form, which was orphaned at the engine level.

§exclude: Vec<String>

Exclude entities whose text matches this token. Repeatable — --exclude OAuth --exclude SAML drops every hit driven by either. Maps to Query.not. When combined with --field, the exclude scopes to that field via the engine’s existing Query.field semantics.

Example: memstead search auth --exclude OAuth returns “auth”-matching entities that are not driven by an OAuth match.

§phrase: Option<String>

Restrict hits to entities containing this exact phrase (adjacency-sensitive). Maps to Query.phrase. Composable with --field (narrows the phrase match to one field) and --exclude (drops phrase-matching hits that also match the excluded token). Shell quoting is stripped before the binary sees the positional text argument — use this flag rather than quoting in the positional to express adjacency.

§edge_type: Option<String>

Filter by edge type (e.g. USES, IMPLEMENTS).

§related_to: Option<String>

Only entities within --depth hops of this ID.

§depth: Option<usize>§limit: Option<usize>§offset: Option<usize>§level: Option<String>§status: Option<String>§filter: Vec<String>

Equality filter on any schema-declared filterable field: repeatable --filter KEY=VALUE. The four named-flag shortcuts (--type / --level / --status / --edge-type) handle their common cases; every other filterable: equality field (e.g. tags, scope) is reachable via this generic flag. Unknown keys are dropped and surface as engine warnings. There is no --confidence shortcut: a field reached only when a schema declares it goes through --filter <field>=<value> rather than a dedicated flag.

§range_filter: Vec<String>

Range filter on any filterable: range field: repeatable --range-filter KEY=VALUE with the same key grammar as the MCP range_filters map — min_<field> / max_<field> for numbers, <field>_after / <field>_before for dates. The strings go to the same engine path the MCP tool uses, so the same four outcome codes apply with the same meaning: RANGE_FILTER_KEY_MALFORMED (key ignored), UNKNOWN_RANGE_FILTER_FIELD (no type declares the field — results stay unfiltered), RANGE_FILTER_TYPE_SCOPED (other types declare it — applied with strict type-narrowing), FIELD_NOT_RANGE_FILTERABLE (declared, but not filterable: range). Composable with --filter and the named shortcuts.

§expand_via: Vec<String>

Relationship types to follow from primary hits to pull in graph-proximal neighbours: repeatable --expand-via REL_TYPE. Mirrors the MCP expand_via parameter — expanded hits carry expansion: { of, via_edge, via_direction, depth } and a decayed score (0.5^depth).

§expand_depth: Option<usize>

Max hops to traverse via --expand-via (default: 1). Mirrors the MCP expand_depth parameter.

§direction: DirectionArg

Traversal direction for --related-to and --expand-via, applied at EVERY hop: out follows edges pointing away from the seed (what does this rest on), in follows edges pointing at it (what rests on this), both (default) is the historical undirected walk. Depth > 1 is a pure transitive closure in the chosen direction — never a mixed walk.

§stub: bool

Return only stub entities (conflicts with –no-stub).

§no_stub: bool

Return only real (non-stub) entities (conflicts with –stub).

Trait Implementations§

Source§

impl Args for Args

Source§

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments
Source§

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut Read more
Source§

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut Read more
Source§

impl CommandFactory for Args

Source§

fn command<'b>() -> Command

Build a Command that can instantiate Self. Read more
Source§

fn command_for_update<'b>() -> Command

Build a Command that can update self. Read more
Source§

impl Debug for Args

Source§

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

Formats the value using the given formatter. Read more
Source§

impl FromArgMatches for Args

Source§

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

impl Parser for Args

Source§

fn parse() -> Self

Parse from std::env::args_os(), exit on error.
Source§

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.
Source§

fn parse_from<I, T>(itr: I) -> Self
where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.
Source§

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>
where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.
Source§

fn update_from<I, T>(&mut self, itr: I)
where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error. Read more
Source§

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>
where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

Auto Trait Implementations§

§

impl Freeze for Args

§

impl RefUnwindSafe for Args

§

impl Send for Args

§

impl Sync for Args

§

impl Unpin for Args

§

impl UnsafeUnpin for Args

§

impl UnwindSafe for Args

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Send + Sync>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Fruit for T
where T: Send + Downcast,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more