Trait holochain::conductor::api::AdminInterfaceApi

pub trait AdminInterfaceApi: 'static + Send + Sync + Clone {
    fn handle_admin_request_inner<'life0, 'async_trait>(
        &'life0 self,
        request: AdminRequest
    ) -> Pin<Box<dyn Future<Output = ConductorApiResult<AdminResponse>> + Send + 'async_trait>>
    where
        Self: 'async_trait,
        'life0: 'async_trait;

    fn handle_admin_request<'life0, 'async_trait>(
        &'life0 self,
        request: AdminRequest
    ) -> Pin<Box<dyn Future<Output = AdminResponse> + Send + 'async_trait>>
    where
        Self: 'async_trait,
        'life0: 'async_trait,
    { ... }
}

A trait for the interface that a Conductor exposes to the outside world to use for administering the conductor. This trait has one mock implementation and one “real” implementation

Required Methods

fn handle_admin_request_inner<'life0, 'async_trait>(
    &'life0 self,
    request: AdminRequest
) -> Pin<Box<dyn Future<Output = ConductorApiResult<AdminResponse>> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Call an admin function to modify this Conductor’s behavior

Provided Methods

fn handle_admin_request<'life0, 'async_trait>(
    &'life0 self,
    request: AdminRequest
) -> Pin<Box<dyn Future<Output = AdminResponse> + Send + 'async_trait>>where
    Self: 'async_trait,
    'life0: 'async_trait,

Deal with error cases produced by handle_admin_request_inner

Examples found in repository

src/conductor/api/api_external/admin_interface.rs (line 315)

    async fn handle_request(
        &self,
        request: Result<Self::ApiRequest, SerializedBytesError>,
    ) -> InterfaceResult<Self::ApiResponse> {
        // Don't hold the read across both awaits
        {
            self.conductor_handle
                .check_running()
                .map_err(Box::new)
                .map_err(InterfaceError::RequestHandler)?;
        }
        match request {
            Ok(request) => Ok(AdminInterfaceApi::handle_admin_request(self, request).await),
            Err(e) => Ok(AdminResponse::Error(SerializationError::from(e).into())),
        }
    }

Implementors

impl AdminInterfaceApi for RealAdminInterfaceApi