Struct RouterBuildContext 

#[non_exhaustive]
pub struct RouterBuildContext<'a> {
    pub service: &'static ServiceSchema<'static>,
    pub targets: &'a [OperationTarget],
    pub config: &'a ServiceConfig,
    pub protocol_settings: Option<&'a Document>,
}

Everything a protocol sees when building its router: the service, the assigned targets, the shared service configuration, and the protocol’s own settings section. Self::service_protocols lets a protocol detect conflicting combinations or adapt its claim behavior using the existing service schema. Constructed by the routing service builder, so a protocol never sees another protocol’s settings.

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.

service: &'static ServiceSchema<'static>

The service schema.

targets: &'a [OperationTarget]

The operations to route, with targets assigned by the routing service.

config: &'a ServiceConfig

Typed service-wide configuration shared by every protocol.

protocol_settings: Option<&'a Document>

This protocol’s section of ProtocolOptions::protocol_settings, when one was configured.

Implementations

impl RouterBuildContext<'_>

pub fn service_protocols(&self) -> &'static [ShapeId<'static>]

Returns the protocols served by this service in schema order, not claim order.

Includes this protocol, but excludes registered protocols the service does not serve. The slice borrows the static service schema and can be retained by the router without copying it or borrowing the build context.

Trait Implementations

impl<'a> Debug for RouterBuildContext<'a>

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

Formats the value using the given formatter.