pib-client-cached 0.22.0

API client for pib-service - caching data storage
Documentation
// SPDX-FileCopyrightText: Politik im Blick developers
// SPDX-FileCopyrightText: Wolfgang Silbermayr <wolfgang@silbermayr.at>
//
// SPDX-License-Identifier: AGPL-3.0-or-later OR EUPL-1.2

use async_trait::async_trait;
use pib_service_api_types::Pagination;
use pib_service_core_types::{DataItem, DataPage, Entity};

mod agenda_item;
mod body;
mod consultation;
mod meeting;
mod membership;
mod organization;
mod permission;
mod person;
mod user;

#[async_trait(?Send)]
pub(super) trait GetableItem<PARENTID, ID, T>
where
    T: Entity<PARENTID, ID>,
{
    async fn get<C: pib_client::PibClient>(
        client: &C,
        parent_id: PARENTID,
        id: ID,
    ) -> Result<DataItem<PARENTID, ID, T>, C::ClientError>;
}

#[async_trait(?Send)]
pub(super) trait AliasGetableItem<PARENTID, ID, T, ALIAS>
where
    T: Entity<PARENTID, ID>,
{
    async fn get_by_alias<C: pib_client::PibClient>(
        client: &C,
        parent_id: PARENTID,
        alias: ALIAS,
    ) -> Result<DataItem<PARENTID, ID, T>, C::ClientError>;

    fn get_aliases(item: &DataItem<PARENTID, ID, T>) -> Vec<ALIAS>;
}

#[async_trait(?Send)]
pub(super) trait PageableItem<PARENTID, ID, T>
where
    T: Entity<PARENTID, ID>,
{
    async fn get_page<C: pib_client::PibClient>(
        client: &C,
        parent_id: PARENTID,
        pagination: Pagination,
    ) -> Result<DataPage<PARENTID, ID, T>, C::ClientError>;
}

#[async_trait(?Send)]
pub(super) trait CreateableItem<PARENTID, ID, T, NEWPARENTID = PARENTID, NEW = T>
where
    T: Entity<NEWPARENTID, ID>,
{
    async fn create<C: pib_client::PibClient>(
        client: &C,
        parent_id: NEWPARENTID,
        new_item: NEW,
    ) -> Result<DataItem<NEWPARENTID, ID, T>, C::ClientError>;
}

#[async_trait(?Send)]
pub(super) trait PlaceableItem<PARENTID, ID, T, NEWPARENTID = PARENTID, NEW = T>
where
    T: Entity<NEWPARENTID, ID>,
{
    async fn place<C: pib_client::PibClient>(
        client: &C,
        parent_id: NEWPARENTID,
        id: ID,
        new_item: NEW,
    ) -> Result<DataItem<NEWPARENTID, ID, T>, C::ClientError>;
}

#[async_trait(?Send)]
pub(super) trait UpdatableItem<PARENTID, ID, T, UPDATE>
where
    T: Entity<PARENTID, ID>,
{
    async fn update<C: pib_client::PibClient>(
        client: &C,
        parent_id: PARENTID,
        id: ID,
        update_item: UPDATE,
    ) -> Result<DataItem<PARENTID, ID, T>, C::ClientError>;
}

#[async_trait(?Send)]
pub(super) trait AliasUpdatableItem<PARENTID, ID, T, UPDATE, ALIAS>
where
    T: Entity<PARENTID, ID>,
{
    async fn update_by_alias<C: pib_client::PibClient>(
        client: &C,
        parent_id: PARENTID,
        alias: ALIAS,
        update_item: UPDATE,
    ) -> Result<DataItem<PARENTID, ID, T>, C::ClientError>;
}