Skip to main content

SubjectKind

Enum SubjectKind 

Source
pub enum SubjectKind {
    Claim,
    Rule,
    Feature,
    Command,
    Capability,
    Mcp,
    UseCase,
}
Expand description

What kind of declaration a subject is. The declaration order is the order the committed index lists its kinds in.

use majordomus_cli::evidence::subject::SubjectKind;

let key = SubjectKind::Command.key("commit plan");
assert_eq!(key, "command:commit plan");
assert_eq!(SubjectKind::parse(&key), Some((SubjectKind::Command, "commit plan")));
assert_eq!(serde_json::to_value(SubjectKind::UseCase).unwrap(), "use_case");

Variants§

§

Claim

A claim of docs/CLAIMS.yaml.

§

Rule

A rule of the layer, by id without its version.

§

Feature

A feature under .ai/repo/features/.

§

Command

A public shell command or a native command path, its words joined by one space.

§

Capability

A builtin capability of the executable.

§

Mcp

An MCP tool name: an alias of its capability.

§

UseCase

A use case under .ai/repo/use-cases/.

Implementations§

Source§

impl SubjectKind

Source

pub const ALL: [SubjectKind; 7]

Every kind, in declaration order.

Source

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

The word a key starts with: the kind’s serialised name.

use majordomus_cli::evidence::subject::SubjectKind;
assert_eq!(SubjectKind::Claim.prefix(), "claim");
assert_eq!(SubjectKind::UseCase.prefix(), "use_case");
Source

pub fn key(self, id: &str) -> String

The key of the subject of this kind with this id: <prefix>:<id>.

use majordomus_cli::evidence::subject::SubjectKind;
assert_eq!(SubjectKind::Rule.key("project.scope"), "rule:project.scope");
Source

pub fn parse(key: &str) -> Option<(SubjectKind, &str)>

Read a key back into its kind and its id, or None when it is not a subject key.

The key splits at its first :, so an id may carry colons and spaces of its own; the prefix must be a kind’s, and the id must not be empty.

use majordomus_cli::evidence::subject::SubjectKind;
assert_eq!(
    SubjectKind::parse("command:commit plan"),
    Some((SubjectKind::Command, "commit plan"))
);
assert_eq!(SubjectKind::parse("gate:x"), None, "not a kind");
assert_eq!(SubjectKind::parse("claim:"), None, "no id");
assert_eq!(SubjectKind::parse("nonsense"), None);
Source

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

The site section a subject of this kind has its page in, or None when the kind has no page of its own (a rule, an MCP alias).

use majordomus_cli::evidence::subject::SubjectKind;
assert_eq!(SubjectKind::UseCase.section(), Some("use-cases"));
assert_eq!(SubjectKind::Mcp.section(), None);

Trait Implementations§

Source§

impl Clone for SubjectKind

Source§

fn clone(&self) -> SubjectKind

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 SubjectKind

Source§

impl Debug for SubjectKind

Source§

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

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

impl<'de> Deserialize<'de> for SubjectKind

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for SubjectKind

Source§

impl JsonSchema for SubjectKind

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl Ord for SubjectKind

Source§

fn cmp(&self, other: &SubjectKind) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for SubjectKind

Source§

fn eq(&self, other: &SubjectKind) -> 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 PartialOrd for SubjectKind

Source§

fn partial_cmp(&self, other: &SubjectKind) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Serialize for SubjectKind

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for SubjectKind

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
§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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