#[non_exhaustive]pub struct Capabilities {
pub managed: bool,
pub query: QueryCapsView,
pub kv: KvCapsView,
pub graph: bool,
pub fork: bool,
pub agent_workflow: bool,
pub watch: bool,
pub authz: bool,
pub versions: OpVersions,
pub backends: Vec<BackendDescriptor>,
pub topology: Option<WireTopology>,
}Expand description
GET /agdx/capabilities reply: what the /agdx/* surface offers on this
server, so a browser client can feature-detect before showing the
projections / query / KV / fork views. Richer than the binary AGDX_HELLO
probe (per-surface flags plus the wire op versions the JSON bodies must
match), and it answers truthfully even when the managed backend is disabled (200
with managed: false).
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.managed: boolConnected to a managed plane at all (the root: with no plane every managed
surface below is off, and the reply still answers 200 with managed: false).
query: QueryCapsViewThe managed query surface, its registry browse views, and the strongest read-consistency it serves.
kv: KvCapsViewThe managed key-value surface and its conditional-write support.
graph: boolWhether the knowledge-graph ops (traversal, neighbors) are served. The
agentic-memory API composes the query and graph surfaces, so it has no
flag of its own: a client reads query and graph.
fork: boolWhether copy-on-write forks are served.
agent_workflow: boolWhether the agent and workflow control band is served. Off until the plane serves it (the engine is a later phase).
watch: boolWhether the change feed is published (one change record per committed notifying projector batch on the changes topic). Off by default: a client that waits on an unpublished feed would wait forever.
authz: boolWhether the authorization control band (AGDX_AUTHZ_*) is served, so a
console can show its roles and bindings surface. Off by default.
versions: OpVersions§backends: Vec<BackendDescriptor>Materialization backends the server currently exposes, so a client can show what it may route to. Identity only (id + engine kind), no settings or secrets. Empty (the default) is skipped on encode, so a pre-backends capabilities reply stays byte-identical.
topology: Option<WireTopology>The stream/topic names this deployment uses, mirroring
crate::hello::BackendAnnounce::topology. Absent (the default) is
skipped on encode, so a pre-topology capabilities reply stays
byte-identical and an older reader falls back to
WireTopology::default.
Implementations§
Source§impl Capabilities
impl Capabilities
Sourcepub fn new(enabled: bool, versions: OpVersions) -> Self
pub fn new(enabled: bool, versions: OpVersions) -> Self
Constructor for the non-exhaustive wire struct. The core surfaces track
enabled, the way the binary AGDX_HELLO probe answers. The per-surface
sub-features (kv.cas, query.consistency above eventual, graph) all
start off: a server must opt into each, never over-advertising (which would
turn a clean unsupported error into a silent wrong answer). Build them with
from_versions or the setters.
Sourcepub fn with_graph(self, value: bool) -> Self
pub fn with_graph(self, value: bool) -> Self
Advertise that the knowledge-graph ops are served. Off by default: a server sets it only when a backend implements the graph surface.
Sourcepub fn with_agent_workflow(self, value: bool) -> Self
pub fn with_agent_workflow(self, value: bool) -> Self
Advertise that the agent and workflow control band is served. Off by default: a server sets it only when it serves the band.
Sourcepub fn with_query_keyword(self, value: bool) -> Self
pub fn with_query_keyword(self, value: bool) -> Self
Set whether lexical keyword search is served on the query surface.
Sourcepub fn with_watch(self, value: bool) -> Self
pub fn with_watch(self, value: bool) -> Self
Advertise that the change feed is published. Only a deployment whose projector emits change records may set it.
Sourcepub fn with_authz(self, value: bool) -> Self
pub fn with_authz(self, value: bool) -> Self
Advertise that the authorization control band is served.
Sourcepub fn with_backends(self, backends: Vec<BackendDescriptor>) -> Self
pub fn with_backends(self, backends: Vec<BackendDescriptor>) -> Self
Advertise the materialization backends the server exposes. The wire pins no engine, so a server lists whatever it has open by id and kind.
Sourcepub fn with_topology(self, topology: WireTopology) -> Self
pub fn with_topology(self, topology: WireTopology) -> Self
Advertise the deployment’s topology, mirroring
crate::hello::BackendAnnounce::with_topology.
Sourcepub fn with_kv_cas(self, on: bool) -> Self
pub fn with_kv_cas(self, on: bool) -> Self
Advertise compare-and-swap on the KV surface (AGDX_KV_CAS). Only a
backend that does a genuine conditional write may set it.
Sourcepub fn with_kv_cas_fenced(self, on: bool) -> Self
pub fn with_kv_cas_fenced(self, on: bool) -> Self
Advertise fenced compare-and-swap on the KV surface (AGDX_KV_CAS_FENCED).
Only a backend that gates a write on a live fence sequence may set it.
Sourcepub fn with_query_consistency(self, level: Consistency) -> Self
pub fn with_query_consistency(self, level: Consistency) -> Self
Advertise the strongest read-consistency the query surface serves.
Sourcepub fn from_versions(enabled: bool, versions: OpVersions) -> Self
pub fn from_versions(enabled: bool, versions: OpVersions) -> Self
Build the HTTP capabilities from the same OpVersions the binary
AGDX_HELLO probe answers with, reading the per-surface sub-features
straight off its features bitset and graph op version. A server SHOULD
use this so its two capability carriages (the binary features bits and
these HTTP fields) cannot disagree: the one source drives both.
Trait Implementations§
Source§impl Clone for Capabilities
impl Clone for Capabilities
Source§fn clone(&self) -> Capabilities
fn clone(&self) -> Capabilities
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for Capabilities
impl Debug for Capabilities
Source§impl<'de> Deserialize<'de> for Capabilities
impl<'de> Deserialize<'de> for Capabilities
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
impl Eq for Capabilities
Source§impl PartialEq for Capabilities
impl PartialEq for Capabilities
Source§impl Serialize for Capabilities
impl Serialize for Capabilities
impl StructuralPartialEq for Capabilities
Auto Trait Implementations§
impl Freeze for Capabilities
impl RefUnwindSafe for Capabilities
impl Send for Capabilities
impl Sync for Capabilities
impl Unpin for Capabilities
impl UnsafeUnpin for Capabilities
impl UnwindSafe for Capabilities
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.