Skip to main content

InterfaceEntry

Struct InterfaceEntry 

Source
pub struct InterfaceEntry {
    pub logical_name: String,
    pub kind: InterfaceKind,
    pub source: String,
    pub rest_url: Option<String>,
    pub graphql_field: Option<String>,
    pub ws_url: Option<String>,
    pub sse_url: Option<String>,
    pub mqtt_topic: Option<String>,
    pub mcp_tool: Option<String>,
    pub grpc_method: Option<String>,
}
Expand description

One reachable surface (table on a transport, or a custom function).

Materializes the cross product of (table, transport) plus one entry per custom function so agents can search by logical name without re-deriving URLs.

Fields§

§logical_name: String

Stable lookup key. For tables: {app_id}.{Table}. For custom functions: {app_id}.{function_name}.

§kind: InterfaceKind

Whether this surface comes from a @table or a custom function.

§source: String

Source identifier — same shape as logical_name today; kept separate so future tooling can decorate logical_name (e.g. with operation suffixes) without losing the back-pointer.

§rest_url: Option<String>

REST endpoint when available (/{app}/{Table}).

§graphql_field: Option<String>

GraphQL field path (/{app}/graphql#Query.{Table}).

§ws_url: Option<String>

WebSocket URL (wss://host/{app}/{Table}); host portion is a placeholder template {host} since the inventory builder doesn’t know the listener address at build time.

§sse_url: Option<String>

SSE URL (/{app}/{Table}?stream=sse).

§mqtt_topic: Option<String>

MQTT topic ({app_id}/{Table}).

§mcp_tool: Option<String>

MCP tool name ({table_lower}_get); arbitrary one of the six CRUD tools generated per table — the canonical “discovery breadcrumb” entry. Agents should call tools/list for the full set.

§grpc_method: Option<String>

gRPC method path stub. Best-effort: /{app}.{Table}/Get style. The actual gRPC bridge isn’t implemented yet — no dispatcher ships and the server-wide grpc.enabled config flag is ignored, with a startup tracing::warn! on the legacy key. This field documents the planned shape so inventory consumers can render a stable column.

Trait Implementations§

Source§

impl Clone for InterfaceEntry

Source§

fn clone(&self) -> InterfaceEntry

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 InterfaceEntry

Source§

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

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

impl<'de> Deserialize<'de> for InterfaceEntry

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 InterfaceEntry

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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