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 46 47 48 49 50
// Copyright 2024 New Vector Ltd.
// Copyright 2024 The Matrix.org Foundation C.I.C.
//
// SPDX-License-Identifier: AGPL-3.0-only
// Please see LICENSE in the repository root for full details.
use async_trait::async_trait;
use mas_data_model::User;
use rand_core::RngCore;
use url::Url;
use crate::{repository_impl, Clock};
/// A [`UserTermsRepository`] helps interacting with the terms of service agreed
/// by a [`User`]
#[async_trait]
pub trait UserTermsRepository: Send + Sync {
/// The error type returned by the repository
type Error;
/// Accept the terms of service by a [`User`]
///
/// # Parameters
///
/// * `rng`: A random number generator used to generate IDs
/// * `clock`: The clock used to generate timestamps
/// * `user`: The [`User`] accepting the terms
/// * `terms_url`: The URL of the terms of service the user is accepting
///
/// # Errors
///
/// Returns [`Self::Error`] if the underlying repository fails
async fn accept_terms(
&mut self,
rng: &mut (dyn RngCore + Send),
clock: &dyn Clock,
user: &User,
terms_url: Url,
) -> Result<(), Self::Error>;
}
repository_impl!(UserTermsRepository:
async fn accept_terms(
&mut self,
rng: &mut (dyn RngCore + Send),
clock: &dyn Clock,
user: &User,
terms_url: Url,
) -> Result<(), Self::Error>;
);