Ecng.Backup

Core abstractions for cloud backup services. This library defines the unified interface IBackupService that all backup providers implement.

Overview

The library provides a provider-agnostic API for working with cloud storage services. You can upload, download, delete, and publish files using the same code regardless of whether you're using AWS S3, Azure Blob Storage, Yandex.Disk, or Mega.

Key Types

BackupEntry

Represents a file or folder in cloud storage.

var folder = new BackupEntry { Name = "my-folder" }; var file = new BackupEntry { Name = "data.zip", Parent = folder // Creates path: my-folder/data.zip }; // Get full path including all parents string path = file.GetFullPath(); // "my-folder/data.zip" // Access metadata (populated after FillInfoAsync or FindAsync) long size = file.Size; DateTime modified = file.LastModified;

IBackupService

The main interface for interacting with cloud storage.

public interface IBackupService : IDisposable { // Feature detection bool CanPublish { get; } // Supports public URLs bool CanExpirable { get; } // Supports expiring public URLs bool CanFolders { get; } // Supports folder creation bool CanPartialDownload { get; } // Supports range downloads // Operations Task CreateFolder(BackupEntry entry, CancellationToken ct = default); IAsyncEnumerable<BackupEntry> FindAsync(BackupEntry parent, string criteria); Task FillInfoAsync(BackupEntry entry, CancellationToken ct = default); Task DeleteAsync(BackupEntry entry, CancellationToken ct = default); Task DownloadAsync(BackupEntry entry, Stream stream, long? offset, long? length, Action<int> progress, CancellationToken ct = default); Task UploadAsync(BackupEntry entry, Stream stream, Action<int> progress, CancellationToken ct = default); Task<string> PublishAsync(BackupEntry entry, TimeSpan? expiresIn = null, CancellationToken ct = default); Task UnPublishAsync(BackupEntry entry, CancellationToken ct = default); }

Usage Examples

Uploading a File

// Works with any IBackupService implementation async Task UploadFileAsync(IBackupService service, string localPath, string remotePath) { var entry = new BackupEntry { Name = remotePath }; await using var stream = File.OpenRead(localPath); await service.UploadAsync(entry, stream, progress => { Console.WriteLine($"Upload progress: {progress}%"); }); }