Skip to main content

InboundMessageMeta

Struct InboundMessageMeta 

Source
#[non_exhaustive]
pub struct InboundMessageMeta { pub kind: InboundKind, pub sender_id: Option<String>, pub msg_id: Option<String>, pub inbound_ts: Option<DateTime<Utc>>, pub reply_to_msg_id: Option<String>, pub has_media: bool, pub origin_session_id: Option<Uuid>, }
Expand description

Per-turn metadata about the inbound message that triggered the agent turn.

Stamped on every tool call dispatched to a stdio extension or an MCP server (under params._meta.nexo.inbound). All fields except kind are optional; consumers must tolerate absence and branch gracefully.

§Example — external user message

use nexo_tool_meta::{InboundKind, InboundMessageMeta};

let meta = InboundMessageMeta::external_user("+5491100", "wa.ABCD1234");
assert_eq!(meta.kind, InboundKind::ExternalUser);
assert_eq!(meta.sender_id.as_deref(), Some("+5491100"));
assert_eq!(meta.msg_id.as_deref(), Some("wa.ABCD1234"));

§Example — internal system tick

use nexo_tool_meta::{InboundKind, InboundMessageMeta};

let meta = InboundMessageMeta::internal_system();
assert_eq!(meta.kind, InboundKind::InternalSystem);
assert!(meta.sender_id.is_none());
assert!(meta.msg_id.is_none());

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§kind: InboundKind

Origin discriminator. Always present when the bucket is.

§sender_id: Option<String>

Provider-native sender id (E.164 phone, telegram_user_id, RFC822 from-address, slack U-id, …). None for kinds other than ExternalUser and for paths where the provider does not expose a sender id (e.g. webhook with no auth).

§msg_id: Option<String>

Provider-native message id (single canonical, no shortened alias). Used for idempotency, dedupe, and as the reply_to_msg_id target on subsequent turns. When a debounce window collapses several inbound messages into a single turn, this carries the id of the first message in the batch.

§inbound_ts: Option<DateTime<Utc>>

Inbound timestamp in UTC. Wire shape: RFC3339 string via chrono’s serde adapter. Producers must clamp wildly-skewed provider timestamps to now() before emitting.

§reply_to_msg_id: Option<String>

Provider-native id of the message this one replies to. None when the inbound is not a reply.

§has_media: bool

true when the inbound carries non-text media (image/audio/video/file/sticker). Microapps gate media-aware tools on this; the actual bytes/URLs live in arguments, not in _meta.

§origin_session_id: Option<Uuid>

Origin session id when kind == InterSession (delegation receive). None otherwise.

Implementations§

Source§

impl InboundMessageMeta

Source

pub fn external_user( sender_id: impl Into<String>, msg_id: impl Into<String>, ) -> Self

Build the minimum meta for an external user message (channel plugin / webhook / MCP-channel inbound).

Source

pub fn internal_system() -> Self

Build the meta for a heartbeat / scheduler tick or a yaml-declared internal_system event-subscriber binding.

Source

pub fn inter_session(origin_session_id: Uuid) -> Self

Build the meta for an inter-agent delegation receive. origin_session_id is required — None would be indistinguishable from internal_system.

Source

pub fn with_ts(self, ts: DateTime<Utc>) -> Self

Builder: layer the inbound timestamp.

Source

pub fn with_reply_to(self, reply_to_msg_id: impl Into<String>) -> Self

Builder: layer the reply-to message id.

Source

pub fn with_media(self) -> Self

Builder: flag that the inbound carries non-text media.

Trait Implementations§

Source§

impl Clone for InboundMessageMeta

Source§

fn clone(&self) -> InboundMessageMeta

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 InboundMessageMeta

Source§

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

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

impl<'de> Deserialize<'de> for InboundMessageMeta

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 InboundMessageMeta

Source§

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

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 TS for InboundMessageMeta

Source§

type WithoutGenerics = InboundMessageMeta

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or ().
The only requirement for these dummy types is that EXPORT_TO must be None. Read more
Source§

type OptionInnerType = InboundMessageMeta

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.
Source§

fn ident(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.
Source§

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes
Source§

fn name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters
Source§

fn decl_concrete(cfg: &Config) -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().
Source§

fn decl(cfg: &Config) -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration. Read more
Source§

fn inline(cfg: &Config) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.
Source§

fn inline_flattened(cfg: &Config) -> String

Flatten a type declaration. This function will panic if the type cannot be flattened.
Source§

fn visit_generics(v: &mut impl TypeVisitor)
where Self: 'static,

Iterates over all type parameters of this type.
Source§

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported, relative to the output directory. The returned path does not include any base directory. Read more
Source§

fn visit_dependencies(v: &mut impl TypeVisitor)
where Self: 'static,

Iterates over all dependency of this type.
Source§

fn dependencies(cfg: &Config) -> Vec<Dependency>
where Self: 'static,

Resolves all dependencies of this type recursively.
Source§

fn export(cfg: &Config) -> Result<(), ExportError>
where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all. Read more
Source§

fn export_all(cfg: &Config) -> Result<(), ExportError>
where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies. To export only this type, without its dependencies, use TS::export. Read more
Source§

fn export_to_string(cfg: &Config) -> Result<String, ExportError>
where Self: 'static,

Manually generate bindings for this type, returning a String. This function does not format the output, even if the format feature is enabled. Read more
Source§

impl Eq for InboundMessageMeta

Source§

impl StructuralPartialEq for InboundMessageMeta

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

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