Skip to main content

RingCommand

Struct RingCommand 

Source
pub struct RingCommand {
    pub command_type: String,
    pub payload: String,
    pub actor: String,
    pub role_key: String,
    pub request_id: String,
}
Expand description

A ring command injected into FU.Data for mediated processing.

The command envelope carries the operation type, a JSON payload, the requesting actor identity, their role key, and a correlation ID. All fields serialize to command.* Tree entries via RingCommand::inject_into.

Fields§

§command_type: String

Command type identifier (e.g. user.create).

§payload: String

JSON-serialized command parameters.

§actor: String

Identity of the actor making the request (application-defined label).

CU uses this for authorization decisions. Injected into the Tree as command.admin by convention; applications may interpret this field according to their own identity model.

§role_key: String

Role key of the requesting actor (application-defined label).

CU evaluates permissions based on this role key. Injected into the Tree as command.role by convention.

§request_id: String

Request correlation ID for tracing.

Generated by the web layer, carried through all 6 units, returned in the result for response correlation.

Implementations§

Source§

impl RingCommand

Source

pub fn new( command_type: impl Into<String>, payload: impl Into<String>, actor: impl Into<String>, role_key: impl Into<String>, request_id: impl Into<String>, ) -> Self

Create a new ring command.

Source

pub fn inject_into(&self, tree: &mut Tree)

Inject this command into a Tree as command.* entries.

Source

pub fn extract_from(tree: &Tree) -> Option<Self>

Extract a command from a Tree’s command.* entries.

Returns None if command.type is absent (not a command cycle).

Source

pub fn is_command(tree: &Tree) -> bool

Check if a Tree contains a command (has command.type).

Trait Implementations§

Source§

impl Clone for RingCommand

Source§

fn clone(&self) -> RingCommand

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 Debug for RingCommand

Source§

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

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

impl<'de> Deserialize<'de> for RingCommand

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 PartialEq for RingCommand

Source§

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

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 RingCommand

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

Source§

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

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

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.

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

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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