Struct BackendDescriptor 

#[non_exhaustive]
pub struct BackendDescriptor {
    pub id: String,
    pub kind: String,
    pub label: Option<String>,
    pub version: Option<String>,
    pub capabilities: Vec<String>,
}

One materialization backend a server exposes, advertised so a client can see what it may route to. id is the stable handle a binding references, kind is the engine family as an opaque string, so a new engine is advertised by name without any wire change. Carries identity only, never settings or secrets. Integration-agnostic: the wire pins no specific engine.

Fields (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.

id: String

kind: String

label: Option<String>

Human-friendly display name for a UI, when the server has one. Advisory. Absent (the default, skipped on the wire) means a client derives a label from id or kind.

version: Option<String>

Engine or build version string, opaque to the wire. Advisory, for display and compatibility hints. Absent (the default, skipped on the wire) means the server did not report one.

capabilities: Vec<String>

Opaque capability tags the backend declares about itself, so a consumer can reason about what this backend is good for (e.g. ingest, query, a particular query-surface feature, or a storage trait) and gate a decision before attempting an op. Each tag is an opaque string the wire pins no meaning to: a producer emits what it supports and a consumer matches the tags it understands, ignoring the rest, so a new capability is advertised by name with no wire change. Integration-agnostic. Empty (the default, skipped on the wire) means none declared.

Implementations

impl BackendDescriptor

pub fn new(id: impl Into<String>, kind: impl Into<String>) -> Self

A descriptor for the backend at id of engine family kind.

pub fn with_label(self, label: impl Into<String>) -> Self

Returns a copy with a human-friendly display label.

pub fn with_version(self, version: impl Into<String>) -> Self

Returns a copy advertising an engine or build version.

pub fn with_capabilities<I, S>(self, capabilities: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Returns a copy advertising the opaque capabilities tags this backend declares about itself.

pub fn has_capability(&self, tag: &str) -> bool

Whether the backend declared the opaque capability tag.

Trait Implementations

impl Clone for BackendDescriptor

fn clone(&self) -> BackendDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BackendDescriptor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BackendDescriptor

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for BackendDescriptor

impl PartialEq for BackendDescriptor

fn eq(&self, other: &BackendDescriptor) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for BackendDescriptor

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BackendDescriptor