Struct ProtocolBuildContext 

#[non_exhaustive]
pub struct ProtocolBuildContext<'a> {
    pub service: &'static ServiceSchema<'static>,
    pub config: &'a ServiceConfig,
    pub settings: Option<&'a Document>,
}

Everything a protocol factory sees.

#[non_exhaustive] — grows without breaking registries.

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 the protocol is being built for.

config: &'a ServiceConfig

Typed service-wide configuration shared by every protocol.

settings: Option<&'a Document>

This protocol’s own section from customizationConfig.protocols.<its shape ID>.

Implementations

impl<'a> ProtocolBuildContext<'a>

pub fn new(service: &'static ServiceSchema<'static>) -> Self

Creates a context with default service configuration and no protocol settings.

pub fn with_config(self, config: &'a ServiceConfig) -> Self

Sets the service-wide configuration.

pub fn with_settings(self, settings: Option<&'a Document>) -> Self

Sets the protocol’s own settings section.

Trait Implementations

impl<'a> Debug for ProtocolBuildContext<'a>

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

Formats the value using the given formatter.