IMountPointFactory.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>
    /// Implement this factory and register it with <see cref="IComponentManager"/>.
    /// Template engine calls <see cref="TryMount"/> with Uri as parameter on all factories
    /// and use mount point from first successful factory.
    /// </summary>
    public interface IMountPointFactory : IIdentifiedComponent
    {
        /// <summary>
        /// Tries to mount specified Uri.
        /// </summary>
        /// <param name="environmentSettings">Environment to be used.</param>
        /// <param name="parent">Mount points can be mounted inside each other. Pass in parent or <c>null</c>.</param>
        /// <param name="mountPointUri">Valid <see cref="Uri"/> that represents mount point.</param>
        /// <param name="mountPoint">Resulting mount point.</param>
        /// <returns><c>true</c> if mount point was successfully mounted.</returns>
        bool TryMount(IEngineEnvironmentSettings environmentSettings, IMountPoint? parent, string mountPointUri, out IMountPoint? mountPoint);
    }
}