// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information.
namespace WixToolset.Dtf.Compression
{
using System;
using System.Collections.Generic;
using System.Text;
///
/// The type of progress event.
///
///
/// PACKING EXAMPLE: The following sequence of events might be received when
/// extracting a simple archive file with 2 files.
///
/// Message TypeDescription
/// - StartArchive Begin extracting archive
/// - StartFile Begin extracting first file
/// - PartialFile Extracting first file
/// - PartialFile Extracting first file
/// - FinishFile Finished extracting first file
/// - StartFile Begin extracting second file
/// - PartialFile Extracting second file
/// - FinishFile Finished extracting second file
/// - FinishArchiveFinished extracting archive
///
///
/// UNPACKING EXAMPLE: Packing 3 files into 2 archive chunks, where the second file is
/// continued to the second archive chunk.
///
/// Message TypeDescription
/// - StartFile Begin compressing first file
/// - FinishFile Finished compressing first file
/// - StartFile Begin compressing second file
/// - PartialFile Compressing second file
/// - PartialFile Compressing second file
/// - FinishFile Finished compressing second file
/// - StartArchive Begin writing first archive
/// - PartialArchiveWriting first archive
/// - FinishArchive Finished writing first archive
/// - StartFile Begin compressing third file
/// - PartialFile Compressing third file
/// - FinishFile Finished compressing third file
/// - StartArchive Begin writing second archive
/// - PartialArchiveWriting second archive
/// - FinishArchive Finished writing second archive
///
///
public enum ArchiveProgressType : int
{
/// Status message before beginning the packing or unpacking an individual file.
StartFile,
/// Status message (possibly reported multiple times) during the process of packing or unpacking a file.
PartialFile,
/// Status message after completion of the packing or unpacking an individual file.
FinishFile,
/// Status message before beginning the packing or unpacking an archive.
StartArchive,
/// Status message (possibly reported multiple times) during the process of packing or unpacking an archiv.
PartialArchive,
/// Status message after completion of the packing or unpacking of an archive.
FinishArchive,
}
}