IMountPoint.cs

// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

namespace Microsoft.TemplateEngine.Abstractions.Mount
{
    /// <summary>
    /// Represents abstract directory.
    /// This could be regular folder on file system, zip file, HTTP server or anything else that can
    /// present files in file system hierarchy.
    /// </summary>
    public interface IMountPoint : IDisposable
    {
        /// <summary>
        /// Returns mount point URI (as received from template package provider = not normalized).
        /// </summary>
        string MountPointUri { get; }

        /// <summary>
        /// Returns root directory of the mount point.
        /// </summary>
        IDirectory Root { get; }

        /// <summary>
        /// <see cref="IEngineEnvironmentSettings"/> used to create this instance.
        /// </summary>
        IEngineEnvironmentSettings EnvironmentSettings { get; }

        /// <summary>
        /// Gets the file info for the file in the mount point.
        /// </summary>
        /// <param name="path">The path to the file relative to mount point root.</param>
        /// <returns></returns>
        IFile? FileInfo(string path);

        /// <summary>
        /// Gets the directory info for the directory in the mount point.
        /// </summary>
        /// <param name="path">The path to the directory relative to mount point root.</param>
        /// <returns></returns>
        IDirectory? DirectoryInfo(string path);

        /// <summary>
        /// Gets the file system entry (file or directory) info for the entry in the mount point.
        /// </summary>
        /// <param name="path">The path to the file system entry relative to mount point root.</param>
        /// <returns></returns>
        IFileSystemInfo? FileSystemInfo(string path);
    }
}