Skip to main content

Capability

Enum Capability 

Source
pub enum Capability {
    SpawnArgs,
    PaneYurai,
    Freio,
}
Expand description

One named thing a daemon build can do. Each variant names a field or a behaviour a caller can gate on — never a release, never a date.

The wire form is a string, deliberately: a client that meets a daemon advertising a capability from a newer vocabulary must ignore the name it doesn’t know, not fail to decode the frame. Strings make that free; a serialized enum would make it a hard error.

Variants§

§

SpawnArgs

The daemon reads the args field on Request::NewSession, Request::NewWindow and Request::SplitPane, and passes it to the child as argv[1..].

A daemon without this reads the request fine — args is #[serde(default)] and no type sets deny_unknown_fields, so the key is simply dropped — and spawns the bare program. That silent drop is the failure this whole module exists to convert into a legible refusal.

§

PaneYurai

The daemon stamps TearPane::yurai at spawn from the connection’s shutai, so a pane records WHAT KIND of actor created it.

Gates provenance READS (tear list showing which panes an agent drives) and is useful with or without a brake. A daemon without it reports every pane as Yurai::Unknown — which is honest, and is also exactly why freio cannot brake Unknown.

§

Freio

The daemon reads Request::SetFreio / Request::GetFreio.

Independent of PaneYurai in one direction only: freio WITHOUT yurai is meaningless (nothing to filter on), yurai without freio is useful on its own. They ship in that order and a client can tell.

This capability is the reason a panic button cannot fail silently: an old daemon would drop SetFreio as an unknown variant and answer a legible Rejected, but the CLI must require() it FIRST so the operator sees a typed refusal rather than a wire error on the one command where “nothing happened” is unacceptable.

Implementations§

Source§

impl Capability

Source

pub const ALL: &'static [Capability]

Every capability name this build’s vocabulary knows. Not the same thing as what a given daemon advertises — see Capability::advertised.

Source

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

The on-wire name. Kebab-case, names the field or behaviour.

Source

pub fn from_wire(s: &str) -> Option<Self>

Parse a wire name back to a typed capability. None for a name from a vocabulary this build doesn’t have — which is the expected outcome when an older client meets a newer daemon, and must stay a quiet miss rather than an error.

Source

pub fn advertised(self) -> bool

Does this build of the daemon implement the capability?

The exhaustive match is the seal: adding a Capability variant without deciding this is error[E0004]: non-exhaustive patterns, so no capability can land unclassified.

Trait Implementations§

Source§

impl Clone for Capability

Source§

fn clone(&self) -> Capability

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 Capability

Source§

impl Debug for Capability

Source§

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

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

impl Eq for Capability

Source§

impl Hash for Capability

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for Capability

Source§

fn cmp(&self, other: &Capability) -> 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 Capability

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for Capability

Source§

fn partial_cmp(&self, other: &Capability) -> 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 StructuralPartialEq for Capability

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
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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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