sharpcompress/SharpCompress/Reader/IReader.cs

using System;
using System.IO;
using SharpCompress.Common;

namespace SharpCompress.Reader
{
    public interface IReader : IDisposable
    {
        event EventHandler<ReaderExtractionEventArgs<IEntry>> EntryExtractionBegin;
        event EventHandler<ReaderExtractionEventArgs<IEntry>> EntryExtractionEnd;

        event EventHandler<CompressedBytesReadEventArgs> CompressedBytesRead;
        event EventHandler<FilePartExtractionBeginEventArgs> FilePartExtractionBegin;

        ArchiveType ArchiveType { get; }

        IEntry Entry { get; }

        /// <summary>
        /// Decompresses the current entry to the stream.  This cannot be called twice for the current entry.
        /// </summary>
        /// <param name="writableStream"></param>
        void WriteEntryTo(Stream writableStream);

        bool Cancelled { get; }
        void Cancel();

        /// <summary>
        /// Moves to the next entry by reading more data from the underlying stream.  This skips if data has not been read.
        /// </summary>
        /// <returns></returns>
        bool MoveToNextEntry();

        /// <summary>
        /// Opens the current entry as a stream that will decompress as it is read.
        /// Read the entire stream or use SkipEntry on EntryStream.
        /// </summary>
        EntryStream OpenEntryStream();
    }
}