Skip to main content

MeshClaimArgs

Struct MeshClaimArgs 

Source
pub struct MeshClaimArgs {
    pub scope: Vec<String>,
    pub session: String,
    pub intent: Option<String>,
    pub advisory: bool,
    pub issue: Option<String>,
    pub task: Option<String>,
    pub query: MeshQueryArgs,
}
Expand description

mesh claim: the paths a session takes, the session taking them, and whether the claim refuses an overlap or only reports one. The scope is positional and repeatable because a claim over nothing is not a claim; --session is required because a claim belongs to a session and ends with it, and --advisory is the difference between a claim that can refuse another runtime’s and one that only makes the overlap visible.

use clap::Parser;
use majordomus_cli::cli::{Cli, Command, MeshClaimArgs, MeshCommand};

let cli = Cli::try_parse_from([
    "majordomus", "mesh", "claim", "src/mesh", "docs/MESH.md",
    "--session", "s1", "--intent", "document the mesh",
])
.unwrap();
let Command::Mesh(mesh) = cli.command else { panic!("expected `mesh`") };
let MeshCommand::Claim(claim) = mesh.command else { panic!("expected `claim`") };
assert_eq!(claim.scope, ["src/mesh", "docs/MESH.md"]);
assert_eq!(claim.session, "s1");
assert!(!claim.advisory, "a claim refuses an overlap unless it says otherwise");

// a claim over no path at all is a parse error, not an empty claim
assert!(Cli::try_parse_from(["majordomus", "mesh", "claim", "--session", "s1"]).is_err());

Fields§

§scope: Vec<String>

Repository-relative paths to claim

§session: String

The claiming session’s id within this runtime (opened when new)

§intent: Option<String>

What the claim is for

§advisory: bool

An advisory claim: overlaps are reported, never refused

§issue: Option<String>

The issue the claim is for

§task: Option<String>

The task the session works under

§query: MeshQueryArgs

Where the repository is and how to answer.

Trait Implementations§

Source§

impl Args for MeshClaimArgs

Source§

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::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 Debug for MeshClaimArgs

Source§

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

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

impl FromArgMatches for MeshClaimArgs

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.

Auto Trait Implementations§

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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