potree-auth 0.1.0

Authentication and project management for `potree` point clouds.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

use std::fmt::Debug;

use async_trait::async_trait;

use super::super::domain::Project;
use super::super::domain::ProjectId;

/// Defines the functionality needed to for the application to interact with
/// persisted [`Project`]s.
#[cfg_attr(test, mockall::automock)]
#[async_trait]
pub trait ProjectRepository: Debug + Send + Sync + 'static {
    /// Read a specific project by its `project_id`. The `project_id` is a
    /// unique identifier of the [`Project`].
    ///
    /// # Errors
    ///
    /// - [`ProjectRepositoryError::ResourceNotFound`] should be returned if the
    /// [`Project`] can't be found.
    /// - [`ProjectRepositoryError::Parsing`] if the project has an invalid
    ///   format.
    async fn read(&self, project_id: &ProjectId) -> Result<Project, ProjectRepositoryError>;

    /// List all the projects available in the datastore.
    ///
    /// Should sort by project.name.
    ///
    /// # Errors
    ///
    /// - [`ProjectRepositoryError::Parsing`] if the project has an invalid
    ///   format.
    async fn list(&self) -> Result<Vec<Project>, ProjectRepositoryError>;
}

#[derive(Debug, Clone, thiserror::Error)]
pub enum ProjectRepositoryError {
    #[error("the `Project` ({id}) could not be found")]
    ResourceNotFound { id: ProjectId },

    #[error("unable to parse the `Project` ({id}) ")]
    Parsing { id: ProjectId },

    #[error("unable to interact with the datastore backend: {message}")]
    Infrastucture { message: String },
}