Struct Args 

pub struct Args {
    pub from_pos: Option<String>,
    pub rel_type_pos: Option<String>,
    pub to_pos: Option<String>,
    pub from_flag: Option<String>,
    pub rel_type_flag: Option<String>,
    pub to_flag: Option<String>,
    pub remove: bool,
    pub description: Option<String>,
    pub note: Option<String>,
    pub dry_run: bool,
}

memstead relate accepts each argument as a positional OR as a named flag — the named forms (--from, --rel-type, --to) bring the command’s call style in line with the sister mutation commands (memstead create, memstead update), which use --title, --type, etc. The positional form continues to work — existing scripts that pipe positional args don’t break.

Fields

from_pos: Option<String>

Source entity ID (positional). Flag synonym: --from.

rel_type_pos: Option<String>

Relationship type (positional). Flag synonym: --rel-type. UPPER_SNAKE_CASE, e.g. USES, PART_OF.

to_pos: Option<String>

Target entity ID (positional). Flag synonym: --to. Creates a stub if the target doesn’t exist.

from_flag: Option<String>

Source entity ID (named flag form).

rel_type_flag: Option<String>

Relationship type (named flag form).

to_flag: Option<String>

Target entity ID (named flag form).

remove: bool

Remove the relationship instead of creating it.

description: Option<String>

Per-edge description applied on add. Validated against the rel-type’s per_edge_description posture; rel-types declared forbidden reject this flag, required reject its absence.

note: Option<String>

Agent-authored provenance note (≤280 chars). When [mutations].require_notes = true a missing note adds a NOTE_MISSING warning.

dry_run: bool

Rehearse the relate: run the full validation (identical refusals and warnings) and report the would-be edge — including a would-be auto-stub, which is reported, never created — without writing anything. commit_sha stays empty (the rehearsal marker); _hash is the prospective post-write hash.

Trait Implementations

impl Args for Args

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

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

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

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

impl CommandFactory for Args

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for Args

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

Formats the value using the given formatter.

impl FromArgMatches for Args

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

Instantiate Self from ArgMatches, parsing the arguments as needed.

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

Instantiate Self from ArgMatches, parsing the arguments as needed.

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

Assign values from ArgMatches to self.

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

Assign values from ArgMatches to self.

impl Parser for Args

fn parse() -> Self

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

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

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

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

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.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

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.