Skip to main content

CommandContext

Struct CommandContext 

Source
pub struct CommandContext {
    pub actor: Option<String>,
    pub correlation_id: Option<String>,
    pub metadata: Option<Value>,
    pub source_device: Option<String>,
}
Expand description

Cross-cutting metadata passed alongside a command.

Carries audit trail, correlation, and tracing information without polluting the Command or DomainEvent types. Fields are mapped onto eventfold::Event metadata when events are appended.

§Examples

use eventfold_es::CommandContext;
use serde_json::json;

let ctx = CommandContext::default()
    .with_actor("user-42")
    .with_correlation_id("req-abc-123")
    .with_metadata(json!({"source": "api"}));

assert_eq!(ctx.actor.as_deref(), Some("user-42"));
assert_eq!(ctx.correlation_id.as_deref(), Some("req-abc-123"));
assert!(ctx.metadata.is_some());

Fields§

§actor: Option<String>

Identity of the actor issuing the command (e.g. a user ID).

§correlation_id: Option<String>

Correlation ID for tracing a request across aggregates.

§metadata: Option<Value>

Arbitrary metadata forwarded to eventfold::Event::meta.

§source_device: Option<String>

The device ID of the client that issued the command.

Stamped into event.meta["source_device"] by to_eventfold_event. Skipped during serialization when None to maintain backward compatibility with existing JSONL records.

Implementations§

Source§

impl CommandContext

Source

pub fn with_actor(self, actor: impl Into<String>) -> Self

Set the actor identity.

§Arguments
  • actor - Any value convertible to String identifying who issued the command (e.g. a user ID or service name).
§Returns

The updated CommandContext with the actor set.

Source

pub fn with_correlation_id(self, id: impl Into<String>) -> Self

Set the correlation ID.

§Arguments
  • id - Any value convertible to String used to correlate this command with other operations across aggregates or services.
§Returns

The updated CommandContext with the correlation ID set.

Source

pub fn with_metadata(self, meta: Value) -> Self

Set arbitrary metadata.

§Arguments
  • meta - A serde_json::Value carrying any additional key-value pairs to forward into eventfold::Event::meta.
§Returns

The updated CommandContext with the metadata set.

Source

pub fn with_source_device(self, device_id: impl Into<String>) -> Self

Set the source device ID.

The device ID identifies which client device originated this command. It is stamped into event.meta["source_device"] by to_eventfold_event, making it available to projections, process managers, and downstream sync consumers.

§Arguments
  • device_id - Any value convertible to String identifying the originating device (e.g. a UUID or hostname).
§Returns

The updated CommandContext with the source device set.

Trait Implementations§

Source§

impl Clone for CommandContext

Source§

fn clone(&self) -> CommandContext

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CommandContext

Source§

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

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

impl Default for CommandContext

Source§

fn default() -> CommandContext

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for CommandContext

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 Serialize for CommandContext

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

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