RobustToolbox/Robust.Shared/ContentPack/IContentRoot.cs

using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.IO;
using Robust.Shared.Utility;

namespace Robust.Shared.ContentPack
{
    internal partial class ResourceManager
    {
        /// <summary>
        ///     Common interface for mounting various things in the VFS.
        /// </summary>
        protected interface IContentRoot
        {
            /// <summary>
            ///     Initializes the content root.
            ///     Throws an exception if the content root failed to mount.
            /// </summary>
            void Mount();

            /// <summary>
            ///     Gets a file from the content root using the relative path.
            /// </summary>
            /// <param name="relPath">Relative path from the root directory.</param>
            /// <param name="stream"></param>
            /// <returns>A stream of the file loaded into memory.</returns>
            bool TryGetFile(ResourcePath relPath, [NotNullWhen(true)] out Stream? stream);

            /// <summary>
            ///     Recursively finds all files in a directory and all sub directories.
            /// </summary>
            /// <param name="path">Directory to search inside of.</param>
            /// <returns>Enumeration of all relative file paths of the files found.</returns>
            IEnumerable<ResourcePath> FindFiles(ResourcePath path);

            /// <summary>
            ///     Recursively returns relative paths to resource files.
            /// </summary>
            /// <returns>Enumeration of all relative file paths.</returns>
            IEnumerable<string> GetRelativeFilePaths();
        }
    }
}