Skip to main content

LocalReason

Enum LocalReason 

Source
pub enum LocalReason {
    Alias(&'static str),
    ProcessLifecycle,
    WritesRepository,
    SessionLocal,
    RendersCapability(&'static str),
}
Expand description

Why a command belongs to the command line alone.

The variants are the four structural reasons this executable has, and there is no fifth for “not projected yet”: a read that belongs in the API and is missing from it is a defect, and a vocabulary that can express it politely is a vocabulary that will.

Variants§

§

Alias(&'static str)

The command runs a default subcommand when none is given: it is that command’s other name, not an operation of its own. The target is the full command, as a person types it after majordomus.

§

ProcessLifecycle

What the command produces is a running process, not a value. There is nothing for a request/response projection to return, and the caller of such a projection would be asking the server to become a different server.

§

WritesRepository

The command writes into the repository. Every projection of the registry is read-only — that is the executable’s first promise — so a command that writes is offered to the person who runs the executable and to nobody over a network.

§

SessionLocal

The command answers about the working copy and the shell that invoked it. A caller over HTTP or MCP does not share either, so the same question asked over a socket would be a different question with the same name, which is worse than not asking it.

§

RendersCapability(&'static str)

The command renders, for a person at a terminal, the value the named capability answers. The operation is in the API; this is its terminal rendering. The domain logic is shared — the command and the capability read the same resolution — and only the shaping of the output is the command’s own.

Implementations§

Source§

impl LocalReason

Source

pub fn renders(self) -> Option<&'static str>

The capability this command renders, when it renders one.

use majordomus_cli::cli::local::LocalReason;
assert_eq!(LocalReason::RendersCapability("web.surfaces").renders(), Some("web.surfaces"));
assert_eq!(LocalReason::ProcessLifecycle.renders(), None);
Source

pub fn aliases(self) -> Option<&'static str>

The command this one is another name for, when it is.

use majordomus_cli::cli::local::LocalReason;
assert_eq!(LocalReason::Alias("why list").aliases(), Some("why list"));
assert_eq!(LocalReason::SessionLocal.aliases(), None);
Source

pub fn as_str(self) -> &'static str

The short word a report and the generated reference show.

use majordomus_cli::cli::local::LocalReason;
assert_eq!(LocalReason::WritesRepository.as_str(), "writes_repository");
assert_eq!(LocalReason::Alias("why list").as_str(), "alias");

Trait Implementations§

Source§

impl Clone for LocalReason

Source§

fn clone(&self) -> LocalReason

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for LocalReason

Source§

impl Debug for LocalReason

Source§

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

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

impl Eq for LocalReason

Source§

impl PartialEq for LocalReason

Source§

fn eq(&self, other: &LocalReason) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for LocalReason

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
§

impl<T> AsOut<T> for T
where T: Copy,

§

fn as_out(&mut self) -> Out<'_, T>

Returns an out reference to self.
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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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