#region Disclaimer / License
// Copyright (C) 2015, The Duplicati Team
// http://www.duplicati.com, info@duplicati.com
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
//
#endregion
using System;
using System.Collections.Generic;
using System.IO;
using System.Text;
namespace Duplicati.Library.Interface
{
///
/// Enumerates the possible modes for compression and decompression
///
public enum ArchiveMode
{
///
/// Indicates compression i.e. write archive mode, which means that the stream must be writeable
///
Write,
///
/// Indicates decompression i.e. read archive mode, which means that the stream must be readable
///
Read
}
///
/// A value that is given to the compressor as a hint
/// to how compressible the file is
///
public enum CompressionHint
{
///
/// Indicates that the compression module should decide
///
Default,
///
/// Indicates that the file is compressible
///
Compressible,
///
/// Indicates that the files is incompressible
///
Noncompressible
}
///
/// An interface for passing additional hints to the compressor
/// about the expected contents of the volume
///
public interface ICompressionHinting : ICompression
{
///
/// Gets or sets a value indicating whether this
/// instance is in low overhead mode.
///
/// true if low overhead mode; otherwise, false.
bool LowOverheadMode { get; set; }
}
public interface IArchiveReader
{
///
/// Returns all files in the archive, matching the prefix, if any.
///
/// An optional prefix for limiting the files returned
/// All files in the archive, matching the prefix, if any
string[] ListFiles(string prefix);
///
/// Returns all files in the archive, matching the prefix, if any.
///
/// An optional prefix for limiting the files returned
/// All files in the archive, matching the prefix, if any
IEnumerable> ListFilesWithSize(string prefix);
///
/// Returns a stream with data from the given file in archive.
///
/// The file to read the data from
/// A stream with data from the given file
System.IO.Stream OpenRead(string file);
///
/// Returns the last modification time for the file
///
/// The name of the file to examine
/// The timestamp on the file
DateTime GetLastWriteTime(string file);
///
/// Returns a value indicating if the specified file exists
///
/// The name of the file to examine
/// True if the file exists, false otherwise
bool FileExists(string file);
}
public interface IArchiveWriter
{
///
/// Creates a file in the archive.
///
/// The file to create in the archive
/// A hint to the compressor as to how compressible the file data is
/// The time the file was last written
/// A stream with the data to write into the file
System.IO.Stream CreateFile(string file, CompressionHint hint, DateTime lastWrite);
///
/// The size in bytes of the buffer that will be written when flushed
///
long FlushBufferSize { get; }
}
///
/// An interface for accessing files in an archive, such as a folder or compressed file.
/// All modules that implements compression must implement this interface.
/// The classes that implements this interface MUST also
/// implement a default constructor and a constructor that
/// has the signature new(string file, Dictionary<string, string> options).
/// The default constructor is used to construct an instance
/// so the DisplayName and other values can be read.
/// The other constructor is used to do the actual work.
/// The input file may not exist or have zero length, in which case it should be created.
///
public interface ICompression : IDisposable, IArchiveReader, IArchiveWriter
{
///
/// The total size of the archive.
///
long Size { get; }
///
/// The extension that the compression implementation adds to the filename
///
string FilenameExtension { get; }
///
/// A localized string describing the compression module with a friendly name
///
string DisplayName { get; }
///
/// A localized description of the compression module
///
string Description { get; }
///
/// Gets a list of supported commandline arguments
///
IList SupportedCommands { get; }
}
}