Struct ServiceInstanceInfo 

#[non_exhaustive]
pub struct ServiceInstanceInfo {
    pub gear: String,
    pub instance_id: String,
    pub endpoint: Option<ServiceEndpoint>,
    pub version: Option<String>,
    pub rest_endpoint: Option<ServiceEndpoint>,
    pub openapi_spec_hash: Option<String>,
    pub grpc_services: Vec<(String, ServiceEndpoint)>,
    pub labels: BTreeMap<String, String>,
    pub state: InstanceState,
}

Information about a service instance

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.

gear: String

Gear name this instance belongs to

instance_id: String

Unique instance identifier

endpoint: Option<ServiceEndpoint>

Primary endpoint for the instance

version: Option<String>

Optional version string

rest_endpoint: Option<ServiceEndpoint>

REST endpoint (HTTP base URL) for this instance, or None if the gear exposes no REST API. This is the address the edge reverse-proxy actually dials for REST routing.

openapi_spec_hash: Option<String>

Stable content token for the published OpenAPI spec, if any.

Enumeration is deliberately spec-free: only this hash rides along, never the full document (fetched out-of-band via DirectoryClient::get_openapi_spec). The hash lets a consumer detect a spec change without inlining N copies of the document.

grpc_services: Vec<(String, ServiceEndpoint)>

Published gRPC services as (service name, endpoint) pairs.

Kept as an ordered list rather than a map so it round-trips a repeated proto field without reordering; service names are unique per instance. Carried back by list_instances so a subsequent register_instance (which replaces the entry wholesale) can augment — rather than clobber — the previously-registered gRPC services when adding a REST endpoint.

labels: BTreeMap<String, String>

Stable addressing labels published by this instance (k8s matchLabels style). Used by DirectoryClient::resolve_by_labels to select shards or peers within a directory name.

state: InstanceState

Live serving state, so a resolve_by_labels caller can apply its own health policy without a second call. Defaults to InstanceState::Registered.

Implementations

impl ServiceInstanceInfo

pub fn new( gear: impl Into<String>, instance_id: impl Into<String>, ) -> ServiceInstanceInfo

Start a projection for gear / instance_id with no primary endpoint and no optional metadata. Chain the with_* builders to populate it. #[non_exhaustive] means callers must use this builder rather than a struct literal, so future fields stay additive.

pub fn with_endpoint( self, endpoint: Option<ServiceEndpoint>, ) -> ServiceInstanceInfo

Set the primary endpoint (None for an instance with no primary endpoint).

pub fn with_version(self, version: Option<String>) -> ServiceInstanceInfo

Set the optional version string.

pub fn with_rest_endpoint( self, rest_endpoint: Option<ServiceEndpoint>, ) -> ServiceInstanceInfo

Set the optional REST endpoint.

pub fn with_openapi_spec_hash( self, openapi_spec_hash: Option<String>, ) -> ServiceInstanceInfo

Set the optional OpenAPI spec content token.

pub fn with_grpc_services( self, grpc_services: Vec<(String, ServiceEndpoint)>, ) -> ServiceInstanceInfo

Set the published gRPC services.

pub fn with_labels( self, labels: BTreeMap<String, String>, ) -> ServiceInstanceInfo

Set the stable addressing labels.

pub fn with_state(self, state: InstanceState) -> ServiceInstanceInfo

Set the live serving state.

pub fn without_labels(self) -> ServiceInstanceInfo

Drop the stable addressing labels, returning self.

The shared transform every DirectoryClient::list_all_instances implementation applies so the cross-gear snapshot omits labels identically across transports — see that method’s doc for why.

Trait Implementations

impl Clone for ServiceInstanceInfo

fn clone(&self) -> ServiceInstanceInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServiceInstanceInfo

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

Formats the value using the given formatter.

impl Default for ServiceInstanceInfo

fn default() -> ServiceInstanceInfo

Returns the “default value” for a type.