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 AbortMultipartReadSetUpload

Source§

impl RuntimePlugin for AcceptShare

Source§

impl RuntimePlugin for BatchDeleteReadSet

Source§

impl RuntimePlugin for CancelAnnotationImportJob

Source§

impl RuntimePlugin for CancelRun

Source§

impl RuntimePlugin for CancelVariantImportJob

Source§

impl RuntimePlugin for CompleteMultipartReadSetUpload

Source§

impl RuntimePlugin for CreateAnnotationStore

Source§

impl RuntimePlugin for CreateAnnotationStoreVersion

Source§

impl RuntimePlugin for CreateMultipartReadSetUpload

Source§

impl RuntimePlugin for CreateReferenceStore

Source§

impl RuntimePlugin for CreateRunCache

Source§

impl RuntimePlugin for CreateRunGroup

Source§

impl RuntimePlugin for CreateSequenceStore

Source§

impl RuntimePlugin for CreateShare

Source§

impl RuntimePlugin for CreateVariantStore

Source§

impl RuntimePlugin for CreateWorkflow

Source§

impl RuntimePlugin for CreateWorkflowVersion

Source§

impl RuntimePlugin for DeleteAnnotationStore

Source§

impl RuntimePlugin for DeleteAnnotationStoreVersions

Source§

impl RuntimePlugin for DeleteReference

Source§

impl RuntimePlugin for DeleteReferenceStore

Source§

impl RuntimePlugin for DeleteRun

Source§

impl RuntimePlugin for DeleteRunCache

Source§

impl RuntimePlugin for DeleteRunGroup

Source§

impl RuntimePlugin for DeleteS3AccessPolicy

Source§

impl RuntimePlugin for DeleteSequenceStore

Source§

impl RuntimePlugin for DeleteShare

Source§

impl RuntimePlugin for DeleteVariantStore

Source§

impl RuntimePlugin for DeleteWorkflow

Source§

impl RuntimePlugin for DeleteWorkflowVersion

Source§

impl RuntimePlugin for GetAnnotationImportJob

Source§

impl RuntimePlugin for GetAnnotationStore

Source§

impl RuntimePlugin for GetAnnotationStoreVersion

Source§

impl RuntimePlugin for GetReadSet

Source§

impl RuntimePlugin for GetReadSetActivationJob

Source§

impl RuntimePlugin for GetReadSetExportJob

Source§

impl RuntimePlugin for GetReadSetImportJob

Source§

impl RuntimePlugin for GetReadSetMetadata

Source§

impl RuntimePlugin for GetReference

Source§

impl RuntimePlugin for GetReferenceImportJob

Source§

impl RuntimePlugin for GetReferenceMetadata

Source§

impl RuntimePlugin for GetReferenceStore

Source§

impl RuntimePlugin for GetRun

Source§

impl RuntimePlugin for GetRunCache

Source§

impl RuntimePlugin for GetRunGroup

Source§

impl RuntimePlugin for GetRunTask

Source§

impl RuntimePlugin for GetS3AccessPolicy

Source§

impl RuntimePlugin for GetSequenceStore

Source§

impl RuntimePlugin for GetShare

Source§

impl RuntimePlugin for GetVariantImportJob

Source§

impl RuntimePlugin for GetVariantStore

Source§

impl RuntimePlugin for GetWorkflow

Source§

impl RuntimePlugin for GetWorkflowVersion

Source§

impl RuntimePlugin for ListAnnotationImportJobs

Source§

impl RuntimePlugin for ListAnnotationStoreVersions

Source§

impl RuntimePlugin for ListAnnotationStores

Source§

impl RuntimePlugin for ListMultipartReadSetUploads

Source§

impl RuntimePlugin for ListReadSetActivationJobs

Source§

impl RuntimePlugin for ListReadSetExportJobs

Source§

impl RuntimePlugin for ListReadSetImportJobs

Source§

impl RuntimePlugin for ListReadSetUploadParts

Source§

impl RuntimePlugin for ListReadSets

Source§

impl RuntimePlugin for ListReferenceImportJobs

Source§

impl RuntimePlugin for ListReferenceStores

Source§

impl RuntimePlugin for ListReferences

Source§

impl RuntimePlugin for ListRunCaches

Source§

impl RuntimePlugin for ListRunGroups

Source§

impl RuntimePlugin for ListRunTasks

Source§

impl RuntimePlugin for ListRuns

Source§

impl RuntimePlugin for ListSequenceStores

Source§

impl RuntimePlugin for ListShares

Source§

impl RuntimePlugin for ListTagsForResource

Source§

impl RuntimePlugin for ListVariantImportJobs

Source§

impl RuntimePlugin for ListVariantStores

Source§

impl RuntimePlugin for ListWorkflowVersions

Source§

impl RuntimePlugin for ListWorkflows

Source§

impl RuntimePlugin for PutS3AccessPolicy

Source§

impl RuntimePlugin for StartAnnotationImportJob

Source§

impl RuntimePlugin for StartReadSetActivationJob

Source§

impl RuntimePlugin for StartReadSetExportJob

Source§

impl RuntimePlugin for StartReadSetImportJob

Source§

impl RuntimePlugin for StartReferenceImportJob

Source§

impl RuntimePlugin for StartRun

Source§

impl RuntimePlugin for StartVariantImportJob

Source§

impl RuntimePlugin for TagResource

Source§

impl RuntimePlugin for UntagResource

Source§

impl RuntimePlugin for UpdateAnnotationStore

Source§

impl RuntimePlugin for UpdateAnnotationStoreVersion

Source§

impl RuntimePlugin for UpdateRunCache

Source§

impl RuntimePlugin for UpdateRunGroup

Source§

impl RuntimePlugin for UpdateSequenceStore

Source§

impl RuntimePlugin for UpdateVariantStore

Source§

impl RuntimePlugin for UpdateWorkflow

Source§

impl RuntimePlugin for UpdateWorkflowVersion

Source§

impl RuntimePlugin for UploadReadSetPart

Source§

impl RuntimePlugin for StaticRuntimePlugin

Source§

impl RuntimePlugin for SharedRuntimePlugin