Skip to main content

SecretsEngine

secrets_core::engine

Trait SecretsEngine 

Source 
pub trait SecretsEngine: Send + Sync {
    // Required methods
    fn read<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        storage: &'life1 dyn StorageBackend,
        path: &'life2 str,
    ) -> Pin<Box<dyn Future<Output = EngineResult<Value>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait;
    fn write<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        storage: &'life1 dyn StorageBackend,
        path: &'life2 str,
        data: Value,
    ) -> Pin<Box<dyn Future<Output = EngineResult<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait;
    fn delete<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        storage: &'life1 dyn StorageBackend,
        path: &'life2 str,
    ) -> Pin<Box<dyn Future<Output = EngineResult<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait;
    fn list<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        storage: &'life1 dyn StorageBackend,
        prefix: &'life2 str,
    ) -> Pin<Box<dyn Future<Output = EngineResult<Vec<String>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait;
    fn doc(&self) -> EngineDoc;

    // Provided methods
    fn generate<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        _storage: &'life1 dyn StorageBackend,
        _role: &'life2 str,
    ) -> Pin<Box<dyn Future<Output = EngineResult<GeneratedCredential>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait { ... }
    fn revoke<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        _storage: &'life1 dyn StorageBackend,
        _lease: &'life2 Lease,
    ) -> Pin<Box<dyn Future<Output = EngineResult<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait { ... }
}

Required Methods§

Source

fn read<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, storage: &'life1 dyn StorageBackend, path: &'life2 str, ) -> Pin<Box<dyn Future<Output = EngineResult<Value>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Source

fn write<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, storage: &'life1 dyn StorageBackend, path: &'life2 str, data: Value, ) -> Pin<Box<dyn Future<Output = EngineResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Source

fn delete<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, storage: &'life1 dyn StorageBackend, path: &'life2 str, ) -> Pin<Box<dyn Future<Output = EngineResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Source

fn list<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, storage: &'life1 dyn StorageBackend, prefix: &'life2 str, ) -> Pin<Box<dyn Future<Output = EngineResult<Vec<String>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Source

fn doc(&self) -> EngineDoc

Self-documentation. Every engine must answer this — an engine that cannot say what its credentials are worth has no business minting them.

Provided Methods§

Source

fn generate<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _storage: &'life1 dyn StorageBackend, _role: &'life2 str, ) -> Pin<Box<dyn Future<Output = EngineResult<GeneratedCredential>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Dynamic-secret engines (e.g. Postgres) override these; static engines (e.g. KV) inherit the default Unsupported.

Source

fn revoke<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _storage: &'life1 dyn StorageBackend, _lease: &'life2 Lease, ) -> Pin<Box<dyn Future<Output = EngineResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Dyn Compatibility§

This trait is dyn compatible.

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

Implementors§