Interface Service

client/src/lib.rs:119–172

/// Abstract interface to interact with an EndBASIC service server.
#[async_trait(?Send)]
pub trait Service {
    /// Interactively creates an account based on the details provided in `request`.
    async fn signup(&mut self, request: &SignupRequest) -> io::Result<()>;

    /// Sends an authentication request to the service with `username` and `password` to obtain an
    /// access token for the session.
    ///
    /// If logging is successful, the access token is cached for future retrieval.
    async fn login(&mut self, username: &str, password: &str) -> io::Result<LoginResponse>;

    /// Logs out from the service and clears the access token from this object.
    async fn logout(&mut self) -> io::Result<()>;

    /// Checks if there is an active session against the service.
    fn is_logged_in(&self) -> bool;

    /// Returns the logged in username if there is an active session.
    fn logged_in_username(&self) -> Option<String>;

    /// Sends a request to the server to obtain the list of files owned by `username` with a
    /// previously-acquired `access_token`.
    async fn get_files(&mut self, username: &str) -> io::Result<GetFilesResponse>;

    /// Sends a request to the server to obtain the contents of `filename` owned by `username` with a
    /// previously-acquired `access_token`.
    async fn get_file(&mut self, username: &str, filename: &str) -> io::Result<Vec<u8>>;

    /// Sends a request to the server to obtain the ACLs of `filename` owned by `username` with a
    /// previously-acquired `access_token`.
    async fn get_file_acls(&mut self, username: &str, filename: &str) -> io::Result<FileAcls>;

    /// Sends a request to the server to update the contents of `filename` owned by `username` as
    /// specified in `content` with a previously-acquired `access_token`.
    async fn patch_file_content(
        &mut self,
        username: &str,
        filename: &str,
        content: Vec<u8>,
    ) -> io::Result<()>;

    /// Sends a request to the server to update the ACLs of `filename` owned by `username` as
    /// specified in `add` and `remove` with a previously-acquired `access_token`.
    async fn patch_file_acls(
        &mut self,
        username: &str,
        filename: &str,
        add: &FileAcls,
        remove: &FileAcls,
    ) -> io::Result<()>;

    /// Sends a request to the server to delete `filename` owned by `username` with a
    /// previously-acquired `access_token`.
    async fn delete_file(&mut self, username: &str, filename: &str) -> io::Result<()>;
}