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

pub mod authorization;

use crate::common::domain::Group;
use crate::common::domain::utils::new_type::new_type;

/// Represents the metadata associated with a 3D model project.
#[derive(Debug, Clone, PartialEq)]
#[cfg_attr(any(test, feature = "fake"), derive(fake::Dummy))]
pub struct Project {
    pub id: ProjectId,

    /// A human readable name for the project.
    pub name: ProjectName,

    /// Optional additional context about the project.
    pub description: Option<ProjectDescription>,

    /// The groups that the project is a member of.
    pub groups: Vec<Group>,
}

new_type![
    /// The unique identifying slug of a [`Project`].
    #[derive(serde::Deserialize, serde::Serialize)]
    ProjectId(String)
];

new_type![
    /// The name of a [`Project`].
    #[derive(serde::Deserialize, serde::Serialize)]
    ProjectName(
        #[cfg_attr(test, dummy(faker = "fake::faker::name::en::Name()"))]
        String
    )
];

new_type![
    /// A high-level description of a [`Project`]. Gives the user more context.
    #[derive(serde::Deserialize, serde::Serialize)]
    ProjectDescription(String)
];