Skip to main content

ClientPlugin

Trait ClientPlugin 

Source
pub trait ClientPlugin:
    Send
    + Sync
    + 'static {
    // Required method
    fn name(&self) -> &str;

    // Provided methods
    fn configure_connection_options(
        &self,
        _options: &mut ConnectionOptions,
    ) -> Result<(), PluginError> { ... }
    fn configure_client_options(
        &self,
        _options: &mut ClientOptions,
    ) -> Result<(), PluginError> { ... }
}
Expand description

Configures connection and namespace-bound client options.

Experimental: This API may change or be removed.

Required Methods§

Source

fn name(&self) -> &str

Return the stable, unique name used to identify this plugin in diagnostics and worker heartbeats.

Provided Methods§

Source

fn configure_connection_options( &self, _options: &mut ConnectionOptions, ) -> Result<(), PluginError>

Configure options before the connection is established.

Source

fn configure_client_options( &self, _options: &mut ClientOptions, ) -> Result<(), PluginError>

Configure options before the namespace-bound client is created.

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§