RuntimePlugin

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 AssociateAccessGrantsIdentityCenter

Source§

impl RuntimePlugin for CreateAccessGrant

Source§

impl RuntimePlugin for CreateAccessGrantsInstance

Source§

impl RuntimePlugin for CreateAccessGrantsLocation

Source§

impl RuntimePlugin for CreateAccessPoint

Source§

impl RuntimePlugin for CreateAccessPointForObjectLambda

Source§

impl RuntimePlugin for CreateBucket

Source§

impl RuntimePlugin for CreateJob

Source§

impl RuntimePlugin for CreateMultiRegionAccessPoint

Source§

impl RuntimePlugin for CreateStorageLensGroup

Source§

impl RuntimePlugin for DeleteAccessGrant

Source§

impl RuntimePlugin for DeleteAccessGrantsInstance

Source§

impl RuntimePlugin for DeleteAccessGrantsInstanceResourcePolicy

Source§

impl RuntimePlugin for DeleteAccessGrantsLocation

Source§

impl RuntimePlugin for DeleteAccessPoint

Source§

impl RuntimePlugin for DeleteAccessPointForObjectLambda

Source§

impl RuntimePlugin for DeleteAccessPointPolicy

Source§

impl RuntimePlugin for DeleteAccessPointPolicyForObjectLambda

Source§

impl RuntimePlugin for DeleteAccessPointScope

Source§

impl RuntimePlugin for DeleteBucket

Source§

impl RuntimePlugin for DeleteBucketLifecycleConfiguration

Source§

impl RuntimePlugin for DeleteBucketPolicy

Source§

impl RuntimePlugin for DeleteBucketReplication

Source§

impl RuntimePlugin for DeleteBucketTagging

Source§

impl RuntimePlugin for DeleteJobTagging

Source§

impl RuntimePlugin for DeleteMultiRegionAccessPoint

Source§

impl RuntimePlugin for DeletePublicAccessBlock

Source§

impl RuntimePlugin for DeleteStorageLensConfiguration

Source§

impl RuntimePlugin for DeleteStorageLensConfigurationTagging

Source§

impl RuntimePlugin for DeleteStorageLensGroup

Source§

impl RuntimePlugin for DescribeJob

Source§

impl RuntimePlugin for DescribeMultiRegionAccessPointOperation

Source§

impl RuntimePlugin for DissociateAccessGrantsIdentityCenter

Source§

impl RuntimePlugin for GetAccessGrant

Source§

impl RuntimePlugin for GetAccessGrantsInstance

Source§

impl RuntimePlugin for GetAccessGrantsInstanceForPrefix

Source§

impl RuntimePlugin for GetAccessGrantsInstanceResourcePolicy

Source§

impl RuntimePlugin for GetAccessGrantsLocation

Source§

impl RuntimePlugin for GetAccessPoint

Source§

impl RuntimePlugin for GetAccessPointConfigurationForObjectLambda

Source§

impl RuntimePlugin for GetAccessPointForObjectLambda

Source§

impl RuntimePlugin for GetAccessPointPolicy

Source§

impl RuntimePlugin for GetAccessPointPolicyForObjectLambda

Source§

impl RuntimePlugin for GetAccessPointPolicyStatus

Source§

impl RuntimePlugin for GetAccessPointPolicyStatusForObjectLambda

Source§

impl RuntimePlugin for GetAccessPointScope

Source§

impl RuntimePlugin for GetBucket

Source§

impl RuntimePlugin for GetBucketLifecycleConfiguration

Source§

impl RuntimePlugin for GetBucketPolicy

Source§

impl RuntimePlugin for GetBucketReplication

Source§

impl RuntimePlugin for GetBucketTagging

Source§

impl RuntimePlugin for GetBucketVersioning

Source§

impl RuntimePlugin for GetDataAccess

Source§

impl RuntimePlugin for GetJobTagging

Source§

impl RuntimePlugin for GetMultiRegionAccessPoint

Source§

impl RuntimePlugin for GetMultiRegionAccessPointPolicy

Source§

impl RuntimePlugin for GetMultiRegionAccessPointPolicyStatus

Source§

impl RuntimePlugin for GetMultiRegionAccessPointRoutes

Source§

impl RuntimePlugin for GetPublicAccessBlock

Source§

impl RuntimePlugin for GetStorageLensConfiguration

Source§

impl RuntimePlugin for GetStorageLensConfigurationTagging

Source§

impl RuntimePlugin for GetStorageLensGroup

Source§

impl RuntimePlugin for ListAccessGrants

Source§

impl RuntimePlugin for ListAccessGrantsInstances

Source§

impl RuntimePlugin for ListAccessGrantsLocations

Source§

impl RuntimePlugin for ListAccessPoints

Source§

impl RuntimePlugin for ListAccessPointsForDirectoryBuckets

Source§

impl RuntimePlugin for ListAccessPointsForObjectLambda

Source§

impl RuntimePlugin for ListCallerAccessGrants

Source§

impl RuntimePlugin for ListJobs

Source§

impl RuntimePlugin for ListMultiRegionAccessPoints

Source§

impl RuntimePlugin for ListRegionalBuckets

Source§

impl RuntimePlugin for ListStorageLensConfigurations

Source§

impl RuntimePlugin for ListStorageLensGroups

Source§

impl RuntimePlugin for ListTagsForResource

Source§

impl RuntimePlugin for PutAccessGrantsInstanceResourcePolicy

Source§

impl RuntimePlugin for PutAccessPointConfigurationForObjectLambda

Source§

impl RuntimePlugin for PutAccessPointPolicy

Source§

impl RuntimePlugin for PutAccessPointPolicyForObjectLambda

Source§

impl RuntimePlugin for PutAccessPointScope

Source§

impl RuntimePlugin for PutBucketLifecycleConfiguration

Source§

impl RuntimePlugin for PutBucketPolicy

Source§

impl RuntimePlugin for PutBucketReplication

Source§

impl RuntimePlugin for PutBucketTagging

Source§

impl RuntimePlugin for PutBucketVersioning

Source§

impl RuntimePlugin for PutJobTagging

Source§

impl RuntimePlugin for PutMultiRegionAccessPointPolicy

Source§

impl RuntimePlugin for PutPublicAccessBlock

Source§

impl RuntimePlugin for PutStorageLensConfiguration

Source§

impl RuntimePlugin for PutStorageLensConfigurationTagging

Source§

impl RuntimePlugin for SubmitMultiRegionAccessPointRoutes

Source§

impl RuntimePlugin for TagResource

Source§

impl RuntimePlugin for UntagResource

Source§

impl RuntimePlugin for UpdateAccessGrantsLocation

Source§

impl RuntimePlugin for UpdateJobPriority

Source§

impl RuntimePlugin for UpdateJobStatus

Source§

impl RuntimePlugin for UpdateStorageLensGroup

Source§

impl RuntimePlugin for StaticRuntimePlugin

Source§

impl RuntimePlugin for SharedRuntimePlugin