BinaryObjectScanner/BinaryObjectScanner.Interfaces/IExtractable.cs

using System.IO;

namespace BinaryObjectScanner.Interfaces
{
    /// <summary>
    /// Mark a file type as being able to be extracted
    /// </summary>
    /// TODO: Change to have output directory passed in
    /// TODO: Change to return a bool
    public interface IExtractable
    {
        /// <summary>
        /// Extract a file to a temporary path, if possible
        /// </summary>
        /// <param name="file">Path to the input file</param>
        /// <param name="includeDebug">True to include debug data, false otherwise</param>
        /// <returns>Path to extracted files, null on error</returns>
        /// <remarks>Ideally, this should just point to the other extract implementation.</remarks>
        string Extract(string file, bool includeDebug);

        /// <summary>
        /// Extract a stream to a temporary path, if possible
        /// </summary>
        /// <param name="stream">Stream representing the input file</param>
        /// <param name="file">Path to the input file</param>
        /// <param name="includeDebug">True to include debug data, false otherwise</param>
        /// <returns>Path to extracted files, null on error</returns>
        string Extract(Stream stream, string file, bool includeDebug);
    }
}