Trait RuntimePlugin

Source
pub trait RuntimePlugin:
    Debug
    + Send
    + Sync {
    // Provided methods
    fn order(&self) -> Order { ... }
    fn config(&self) -> Option<FrozenLayer> { ... }
    fn runtime_components(
        &self,
        current_components: &RuntimeComponentsBuilder,
    ) -> Cow<'_, RuntimeComponentsBuilder> { ... }
}
Expand description

Runtime plugin trait

A RuntimePlugin is the unit of configuration for augmenting the client with new behavior.

Runtime plugins can register interceptors, set runtime components, and modify configuration.

Provided Methods§

Source

fn order(&self) -> Order

Runtime plugin ordering.

There are two runtime plugin “levels” that run in the following order:

  1. Service runtime plugins - runtime plugins that pertain to the entire service.
  2. Operation runtime plugins - runtime plugins relevant only to a single operation.

This function is used to determine runtime plugin order within those levels. So regardless of this Order value, service runtime plugins will still always execute before operation runtime plugins. However, Defaults service runtime plugins will run before Overrides service runtime plugins.

Source

fn config(&self) -> Option<FrozenLayer>

Optionally returns additional config that should be added to the ConfigBag.

As a best practice, a frozen layer should be stored on the runtime plugin instance as a member, and then cloned upon return since that clone is cheap. Constructing a new Layer and freezing it will require a lot of allocations.

Source

fn runtime_components( &self, current_components: &RuntimeComponentsBuilder, ) -> Cow<'_, RuntimeComponentsBuilder>

Returns a RuntimeComponentsBuilder to incorporate into the final runtime components.

The order of runtime plugins determines which runtime components “win”. Components set by later runtime plugins will override those set by earlier runtime plugins.

If no runtime component changes are desired, just return an empty builder.

This method returns a Cow for flexibility. Some implementers may want to store the components builder as a member and return a reference to it, while others may need to create the builder every call. If possible, returning a reference is preferred for performance.

Components configured by previous runtime plugins are in the current_components argument, and can be used to create nested/wrapped components, such as a connector calling into an inner (customer provided) connector.

Implementations on Foreign Types§

Source§

impl RuntimePlugin for PayloadSigningOverrideRuntimePlugin

Source§

impl RuntimePlugin for NoAuthRuntimePlugin

Source§

impl RuntimePlugin for EnforceContentLengthRuntimePlugin

Source§

impl RuntimePlugin for MetricsRuntimePlugin

Source§

impl RuntimePlugin for CannedResponseDeserializer

Source§

impl RuntimePlugin for CannedRequestSerializer

Implementors§

Source§

impl RuntimePlugin for AcceptMarketplaceRegistration

Source§

impl RuntimePlugin for CreateCloudAutonomousVmCluster

Source§

impl RuntimePlugin for CreateCloudExadataInfrastructure

Source§

impl RuntimePlugin for CreateCloudVmCluster

Source§

impl RuntimePlugin for CreateOdbNetwork

Source§

impl RuntimePlugin for CreateOdbPeeringConnection

Source§

impl RuntimePlugin for DeleteCloudAutonomousVmCluster

Source§

impl RuntimePlugin for DeleteCloudExadataInfrastructure

Source§

impl RuntimePlugin for DeleteCloudVmCluster

Source§

impl RuntimePlugin for DeleteOdbNetwork

Source§

impl RuntimePlugin for DeleteOdbPeeringConnection

Source§

impl RuntimePlugin for GetCloudAutonomousVmCluster

Source§

impl RuntimePlugin for GetCloudExadataInfrastructure

Source§

impl RuntimePlugin for GetCloudExadataInfrastructureUnallocatedResources

Source§

impl RuntimePlugin for GetCloudVmCluster

Source§

impl RuntimePlugin for GetDbNode

Source§

impl RuntimePlugin for GetDbServer

Source§

impl RuntimePlugin for GetOciOnboardingStatus

Source§

impl RuntimePlugin for GetOdbNetwork

Source§

impl RuntimePlugin for GetOdbPeeringConnection

Source§

impl RuntimePlugin for InitializeService

Source§

impl RuntimePlugin for ListAutonomousVirtualMachines

Source§

impl RuntimePlugin for ListCloudAutonomousVmClusters

Source§

impl RuntimePlugin for ListCloudExadataInfrastructures

Source§

impl RuntimePlugin for ListCloudVmClusters

Source§

impl RuntimePlugin for ListDbNodes

Source§

impl RuntimePlugin for ListDbServers

Source§

impl RuntimePlugin for ListDbSystemShapes

Source§

impl RuntimePlugin for ListGiVersions

Source§

impl RuntimePlugin for ListOdbNetworks

Source§

impl RuntimePlugin for ListOdbPeeringConnections

Source§

impl RuntimePlugin for ListSystemVersions

Source§

impl RuntimePlugin for ListTagsForResource

Source§

impl RuntimePlugin for RebootDbNode

Source§

impl RuntimePlugin for StartDbNode

Source§

impl RuntimePlugin for StopDbNode

Source§

impl RuntimePlugin for TagResource

Source§

impl RuntimePlugin for UntagResource

Source§

impl RuntimePlugin for UpdateCloudExadataInfrastructure

Source§

impl RuntimePlugin for UpdateOdbNetwork

Source§

impl RuntimePlugin for StaticRuntimePlugin

Source§

impl RuntimePlugin for SharedRuntimePlugin