Class Path

include/Core/System/Path.hpp:22–91

* \brief Class used to manipulate paths and dynamically load resources * (Based on multiple mounted paths) * \bind{Path} */

     * \bind{Path}
     */
    class Path
    {
    private:
        std::string m_path;
        const std::vector<MountablePath>& m_mounts;

    public:
        /**
         * \brief Default constructor of Path
         */
        Path();
        /**
         * \brief Build a path from an other path (Copy constructor)
         * \param mount A reference containing the mount points the Path should be using
         */
        Path(const std::vector<MountablePath>& mount);
        /**
         * \brief Build a path from an other path (Copy constructor)
         * \param path The Path to build the new Path from
         */
        Path(const Path& path);
        /**
         * \brief Build a path from a std::string
         * \param path Path in std::string form
         */
        Path(std::string_view path);
        Path& set(const std::string& path);
        /**
         * \brief Returns a new Path which is the current one concatenated with
         *        the given string
         * \param path String containing the path part to add
         * \return The new path which is the result of the base concatenated with
         *         the path parameter
         */
        [[nodiscard]] Path add(const std::string& path) const;
        /**
         * \brief Get the last part of a Path
         * \return The last part of the Path (terminal directory)
         */
        [[nodiscard]] std::string last() const;
        /**
         * \brief Build a path using the current path and the BasePath at given
         *        index
         * \param index Index of the BasePath to use
         * \return The full path based on the current path and the BasePath at index
         */
        Path getPath(std::size_t index) const;
        /**
         * \brief Finds the most prioritized file corresponding to the Path
         * \return The full path to the most prioritized file
         */
        [[nodiscard]] std::string find(PathType pathType = PathType::All) const;
        [[nodiscard]] std::vector<std::string> findAll(
            PathType pathType = PathType::All) const;
        /**
         * \brief Get the current path in string form
         * \return The Path in std::string form
         */