lfilesystem_Volume.h

Go to the documentation of this file.

/*
 * ======================================================================================
 *  __    ____  __  __  ____  ___
 * (  )  (_  _)(  \/  )( ___)/ __)
 *  )(__  _)(_  )    (  )__) \__ \
 * (____)(____)(_/\/\_)(____)(___/
 *
 *  This file is part of the Limes open source library and is licensed under the terms of the GNU Public License.
 *
 *  Commercial licenses are available; contact the maintainers at ben.the.vining@gmail.com to inquire for details.
 *
 * ======================================================================================
 */
 
#pragma once
 
#include <string>
#include <cstdint>
#include <filesystem>
#include <vector>
#include <optional>
#include <ostream>
#include "lfilesystem/lfilesystem_Export.h"
#include "lfilesystem/lfilesystem_SpecialDirectories.h"
 
namespace limes::files
{
 
using Path = std::filesystem::path;
 
class FilesystemEntry;
 
class LFILE_EXPORT Volume final
{
public:
    explicit Volume (const Path& path = dirs::cwd().getAbsolutePath());
 
    [[nodiscard]] static std::optional<Volume> tryCreate (const Path& path = dirs::cwd().getAbsolutePath()) noexcept;
 
    bool operator== (const Volume& other) const noexcept;
 
    bool operator!= (const Volume& other) const noexcept;
 
    [[nodiscard]] bool contains (const FilesystemEntry& file) const noexcept;
 
    [[nodiscard]] std::string getLabel() const;
 
    [[nodiscard]] int getSerialNumber() const;
 
    [[nodiscard]] std::uintmax_t bytesFree() const;
 
    [[nodiscard]] std::uintmax_t totalBytes() const;
 
    [[nodiscard]] Path getPath() const noexcept;
 
    enum class Type
    {
        CDRom,      
        HardDisk,   
        Removable,  
        Network,    
        RAM,        
        Unknown     
    };
 
    [[nodiscard]] Type getType() const;
 
    [[nodiscard]] bool isReadOnly() const;
 
    [[nodiscard]] bool isCaseSensitive() const;
 
    [[nodiscard]] static std::vector<Volume> getAll() noexcept;
 
private:
    Path rootPath;
};
 
std::ostream& operator<< (std::ostream& os, const Volume& value);
 
namespace volume
{
 
[[nodiscard]] LFILE_EXPORT std::string label();
 
[[nodiscard]] LFILE_EXPORT int serialNumber();
 
[[nodiscard]] LFILE_EXPORT std::uintmax_t bytesFree();
 
[[nodiscard]] LFILE_EXPORT std::uintmax_t totalBytes();
 
[[nodiscard]] LFILE_EXPORT Volume::Type type();
 
[[nodiscard]] LFILE_EXPORT bool readOnly();
 
[[nodiscard]] LFILE_EXPORT bool caseSensitive();
 
}  // namespace volume
 
}  // namespace files