src/Files.App/Data/Contracts/ICompressArchiveModel.cs - main - githubmirror/Files

src/Files.App/Data/Contracts/ICompressArchiveModel.cs

94 строки2 KB

yair100

Feature: Added prompt when there is issue compressing file (#18723)

16 июл 2026, 21:59

16 июл 2026, 21:59b30f334

// Copyright (c) Files Community
// Licensed under the MIT License.

namespace Files.App.Data.Contracts
{
	/// <summary>
	/// Represents an interface for archive creation support.
	/// </summary>
	public interface ICompressArchiveModel
	{
		/// <summary>
		/// File path to archive.
		/// </summary>
		string ArchivePath { get; set; }

		/// <summary>
		/// Directory name.
		/// </summary>
		string Directory { get; }

		/// <summary>
		/// File name.
		/// </summary>
		string FileName { get; }

		/// <summary>
		/// Password.
		/// </summary>
		string Password { get; }

		/// <summary>
		/// Source.
		/// </summary>
		IEnumerable<string> Sources { get; }

		/// <summary>
		/// Archive file format.
		/// </summary>
		ArchiveFormats FileFormat { get; }

		/// <summary>
		/// Archive compression level.
		/// </summary>
		ArchiveCompressionLevels CompressionLevel { get; }

		/// <summary>
		/// 7zip archive splitting size.
		/// </summary>
		ArchiveSplittingSizes SplittingSize { get; }

		/// <summary>
		/// 7zip archive dictionary size.
		/// </summary>
		ArchiveDictionarySizes DictionarySize { get; }

		/// <summary>
		/// 7zip archive word size (fast bytes).
		/// </summary>
		ArchiveWordSizes WordSize { get; }

		/// <summary>
		/// Number of CPU Threads to use.
		/// </summary>
		int CPUThreads { get; }

		/// <summary>
		/// Archiving progress.
		/// </summary>
		IProgress<StatusCenterItemProgressModel> Progress { get; set; }

		/// <summary>
		/// Cancellation request.
		/// </summary>
		CancellationToken CancellationToken { get; set; }

		/// <summary>
		/// Whether the creation was cancelled by the user, e.g. by declining to skip items that cannot be archived.
		/// </summary>
		bool IsCancelled { get; }

		/// <summary>
		/// Get path which target will be archived to.
		/// </summary>
		/// <param name="suffix"></param>
		/// <returns></returns>
		string GetArchivePath(string suffix = "");

		/// <summary>
		/// Run archive creation command.
		/// </summary>
		/// <returns></returns>
		Task<bool> RunCreationAsync();
	}
}