UiApi

hab_rs_api_client::apis::ui_api

Trait UiApi 

Source 
pub trait UiApi: Send + Sync {
    // Required methods
    fn add_ui_component_to_namespace<'namespace, 'root_ui_component, 'life0, 'async_trait>(
        &'life0 self,
        namespace: &'namespace str,
        root_ui_component: Option<RootUiComponent>,
    ) -> Pin<Box<dyn Future<Output = Result<RootUiComponent, Error<AddUiComponentToNamespaceError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'namespace: 'async_trait,
             'root_ui_component: 'async_trait,
             'life0: 'async_trait;
    fn get_registered_ui_components_in_namespace<'namespace, 'summary, 'life0, 'async_trait>(
        &'life0 self,
        namespace: &'namespace str,
        summary: Option<bool>,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<RootUiComponent>, Error<GetRegisteredUiComponentsInNamespaceError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'namespace: 'async_trait,
             'summary: 'async_trait,
             'life0: 'async_trait;
    fn get_ui_component_in_namespace<'namespace, 'component_uid, 'life0, 'async_trait>(
        &'life0 self,
        namespace: &'namespace str,
        component_uid: &'component_uid str,
    ) -> Pin<Box<dyn Future<Output = Result<RootUiComponent, Error<GetUiComponentInNamespaceError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'namespace: 'async_trait,
             'component_uid: 'async_trait,
             'life0: 'async_trait;
    fn get_ui_tiles<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<TileDto>, Error<GetUiTilesError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn remove_ui_component_from_namespace<'namespace, 'component_uid, 'life0, 'async_trait>(
        &'life0 self,
        namespace: &'namespace str,
        component_uid: &'component_uid str,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error<RemoveUiComponentFromNamespaceError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'namespace: 'async_trait,
             'component_uid: 'async_trait,
             'life0: 'async_trait;
    fn update_ui_component_in_namespace<'namespace, 'component_uid, 'root_ui_component, 'life0, 'async_trait>(
        &'life0 self,
        namespace: &'namespace str,
        component_uid: &'component_uid str,
        root_ui_component: Option<RootUiComponent>,
    ) -> Pin<Box<dyn Future<Output = Result<RootUiComponent, Error<UpdateUiComponentInNamespaceError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'namespace: 'async_trait,
             'component_uid: 'async_trait,
             'root_ui_component: 'async_trait,
             'life0: 'async_trait;
}
Available on crate feature ui_api only.

Required Methods§

Source

fn add_ui_component_to_namespace<'namespace, 'root_ui_component, 'life0, 'async_trait>( &'life0 self, namespace: &'namespace str, root_ui_component: Option<RootUiComponent>, ) -> Pin<Box<dyn Future<Output = Result<RootUiComponent, Error<AddUiComponentToNamespaceError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'namespace: 'async_trait, 'root_ui_component: 'async_trait, 'life0: 'async_trait,

POST /ui/components/{namespace}

Source

fn get_registered_ui_components_in_namespace<'namespace, 'summary, 'life0, 'async_trait>( &'life0 self, namespace: &'namespace str, summary: Option<bool>, ) -> Pin<Box<dyn Future<Output = Result<Vec<RootUiComponent>, Error<GetRegisteredUiComponentsInNamespaceError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'namespace: 'async_trait, 'summary: 'async_trait, 'life0: 'async_trait,

GET /ui/components/{namespace}

Source

fn get_ui_component_in_namespace<'namespace, 'component_uid, 'life0, 'async_trait>( &'life0 self, namespace: &'namespace str, component_uid: &'component_uid str, ) -> Pin<Box<dyn Future<Output = Result<RootUiComponent, Error<GetUiComponentInNamespaceError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'namespace: 'async_trait, 'component_uid: 'async_trait, 'life0: 'async_trait,

GET /ui/components/{namespace}/{componentUID}

Source

fn get_ui_tiles<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<TileDto>, Error<GetUiTilesError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /ui/tiles

Source

fn remove_ui_component_from_namespace<'namespace, 'component_uid, 'life0, 'async_trait>( &'life0 self, namespace: &'namespace str, component_uid: &'component_uid str, ) -> Pin<Box<dyn Future<Output = Result<(), Error<RemoveUiComponentFromNamespaceError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'namespace: 'async_trait, 'component_uid: 'async_trait, 'life0: 'async_trait,

DELETE /ui/components/{namespace}/{componentUID}

Source

fn update_ui_component_in_namespace<'namespace, 'component_uid, 'root_ui_component, 'life0, 'async_trait>( &'life0 self, namespace: &'namespace str, component_uid: &'component_uid str, root_ui_component: Option<RootUiComponent>, ) -> Pin<Box<dyn Future<Output = Result<RootUiComponent, Error<UpdateUiComponentInNamespaceError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'namespace: 'async_trait, 'component_uid: 'async_trait, 'root_ui_component: 'async_trait, 'life0: 'async_trait,

PUT /ui/components/{namespace}/{componentUID}

Implementors§