Struct RestrictedDiscoveryConfigBuilder 

pub struct RestrictedDiscoveryConfigBuilder {
    enabled: Option<bool>,
    watch_configuration: Option<bool>,
    key_dirs: DirectoryKeyProviderListBuilder,
    static_keys: StaticKeyProviderBuilder,
}

A builder to create an instance of RestrictedDiscoveryConfig.

Fields

enabled: Option<bool>

In-progress value for enabled.

See RestrictedDiscoveryConfig.enabled

watch_configuration: Option<bool>

In-progress value for watch_configuration.

See RestrictedDiscoveryConfig.watch_configuration

key_dirs: DirectoryKeyProviderListBuilder

In-progress value for key_dirs.

See RestrictedDiscoveryConfig.key_dirs

static_keys: StaticKeyProviderBuilder

In-progress value for static_keys.

See RestrictedDiscoveryConfig.static_keys

Implementations

impl RestrictedDiscoveryConfigBuilder

pub fn enabled(&mut self, val: bool) -> &mut Self

Provide a value for enabled.

If no value is provided for enabled, build will use Default::default().

enabled

Whether to enable restricted discovery mode.

Services running in restricted discovery mode are only discoverable by the configured clients.

Can only be enabled if the restricted-discovery feature is enabled.

If you enable this, you must also specify the authorized clients (via static_keys), or the directories where the authorized client keys should be read from (via key_dirs).

Restricted discovery mode is disabled by default.

pub fn watch_configuration(&mut self, val: bool) -> &mut Self

Provide a value for watch_configuration.

If no value is provided for watch_configuration, build will use Default::default().

watch_configuration

If true, the provided key_dirs will be watched for changes.

pub fn key_dirs(&mut self) -> &mut DirectoryKeyProviderListBuilder

Return a mutable reference to the inner builder for key_dirs.

key_dirs

Directories containing the client keys, each in the descriptor:x25519:<base32-encoded-x25519-public-key> format.

Each file in this directory must have a file name of the form <nickname>.auth, where <nickname> is a valid HsClientNickname.

pub fn static_keys(&mut self) -> &mut StaticKeyProviderBuilder

Return a mutable reference to the inner builder for static_keys.

static_keys

A static mapping from client nicknames to keys.

Each client key must be in the descriptor:x25519:<base32-encoded-x25519-public-key> format.

impl RestrictedDiscoveryConfigBuilder

pub fn new() -> Self

Return a new builder object.

pub fn build(&self) -> Result<RestrictedDiscoveryConfig, ConfigBuildError>

Try to construct a new RestrictedDiscoveryConfig from the fields set in this builder.

Return an error if any required field is missing, or is set to something invalid.

impl RestrictedDiscoveryConfigBuilder

fn post_build_validate( config: RestrictedDiscoveryConfig, ) -> Result<RestrictedDiscoveryConfig, ConfigBuildError>

Build the RestrictedDiscoveryConfig.

Returns an error if:

• restricted mode is enabled but the restricted-discovery feature is not enabled
• restricted mode is enabled but no client key providers are configured
• restricted mode is disabled, but some client key providers are configured

Trait Implementations

impl Builder for RestrictedDiscoveryConfigBuilder

type Built = RestrictedDiscoveryConfig

The type that this builder constructs.

fn build(&self) -> Result<RestrictedDiscoveryConfig, ConfigBuildError>

Build into a Built

impl Clone for RestrictedDiscoveryConfigBuilder

fn clone(&self) -> RestrictedDiscoveryConfigBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RestrictedDiscoveryConfigBuilder

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

Formats the value using the given formatter.

impl Default for RestrictedDiscoveryConfigBuilder

fn default() -> RestrictedDiscoveryConfigBuilder

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RestrictedDiscoveryConfigBuilder

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl ExtendBuilder for RestrictedDiscoveryConfigBuilder

fn extend_from(&mut self, other: Self, strategy: ExtendStrategy)

Consume other, and merge its contents into self.

impl Flattenable for RestrictedDiscoveryConfigBuilder

fn has_field(s: &str) -> bool

Does this type have a field named s ?

impl Serialize for RestrictedDiscoveryConfigBuilder

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

where __S: Serializer,

Serialize this value into the given Serde serializer.