duplicati/Duplicati/Library/Interface/IFolderEnabledBackend.cs

// Copyright (C) 2025, The Duplicati Team
// https://duplicati.com, hello@duplicati.com
// 
// Permission is hereby granted, free of charge, to any person obtaining a 
// copy of this software and associated documentation files (the "Software"), 
// to deal in the Software without restriction, including without limitation 
// the rights to use, copy, modify, merge, publish, distribute, sublicense, 
// and/or sell copies of the Software, and to permit persons to whom the 
// Software is furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in 
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
// DEALINGS IN THE SOFTWARE.

#nullable enable

using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;

namespace Duplicati.Library.Interface;

/// <summary>
/// An interface a backend may implement if it supports streaming operations.
/// Backends that implement this interface can be throttled and correctly shows 
/// the progressbar when transferring data.
/// </summary>
public interface IFolderEnabledBackend : IBackend
{
    /// <summary>
    /// Enumerates a list of files and folders found on the remote location
    /// </summary>
    /// <param name="path">The path to list, empty or null for the root folder</param>
    /// <param name="cancellationToken">The cancellation token</param>
    /// <returns>The list of files, where paths are scoped to the backend.</returns>
    /// <remarks>
    /// The paths returned should be only the filenames or folder names, not the full path.
    /// Folders should end with the operating system's directory separator.
    /// </remarks>
    IAsyncEnumerable<IFileEntry> ListAsync(string? path, CancellationToken cancellationToken);

    /// <summary>
    /// Gets a single file or folder entry
    /// </summary>
    /// <param name="path">The path to get</param>
    /// <param name="cancellationToken">The cancellation token</param>
    /// <returns>The file or folder entry</returns>
    /// <remarks>
    /// The paths returned should be only the filenames or folder names, not the full path.
    /// Folders should end with the operating system's directory separator.
    /// </remarks>
    Task<IFileEntry?> GetEntryAsync(string path, CancellationToken cancellationToken);
}