desk__up__backend__interface_8h_source.html

#ifndef DESKUPBACKENDINTERFACE_H

#define DESKUPBACKENDINTERFACE_H


#include <string>

#include <expected>

#include <filesystem>


#include "desk_up_error.h"


namespace fs = std::filesystem;


struct DeskUpBackendInterface{


    static DeskUp::Status saveAllWindowsLocal(std::string workspaceName);


    static DeskUp::Status restoreWindows(std::string workspaceName);


    static bool isWorkspaceValid(const std::string& workspaceName);


    static bool existsWorkspace(const std::string& workspaceName);


    static int removeWorkspace(const std::string& workspaceName);


    static bool existsFile(const fs::path& filePath);


};


#endif

desk_up_error.h
Error management system for DeskUp (centralized error representation and conversion utilities).

DeskUp::Status
std::expected< void, DeskUp::Error > Status
Alias for an operation that returns success or failure (void on success).
Definition desk_up_error.h:273

DeskUpBackendInterface
Convenience façade for workspace-level window operations.
Definition desk_up_backend_interface.h:65

DeskUpBackendInterface::existsFile
static bool existsFile(const fs::path &filePath)
Checks whether a given file path exists on disk.
Definition desk_up_backend_interface.cc:194

DeskUpBackendInterface::removeWorkspace
static int removeWorkspace(const std::string &workspaceName)
This function deletes a workspace.
Definition desk_up_backend_interface.cc:174

DeskUpBackendInterface::isWorkspaceValid
static bool isWorkspaceValid(const std::string &workspaceName)
This function checks whether if a string is a valid name for a workspace folder.
Definition desk_up_backend_interface.cc:142

DeskUpBackendInterface::saveAllWindowsLocal
static DeskUp::Status saveAllWindowsLocal(std::string workspaceName)
Saves all currently enumerated windows to a local workspace folder.
Definition desk_up_backend_interface.cc:32

DeskUpBackendInterface::restoreWindows
static DeskUp::Status restoreWindows(std::string workspaceName)
Restores all tabs saved previously in the workspace name specified by the parameter.
Definition desk_up_backend_interface.cc:83

DeskUpBackendInterface::existsWorkspace
static bool existsWorkspace(const std::string &workspaceName)
This function checks whether if a given workspace with the name workspaceName already exists.
Definition desk_up_backend_interface.cc:159