LibHac/libhac.Nand/DiscUtils.Core/Compression/CompressionResult.cs

//
// Copyright (c) 2008-2011, Kenneth Bell
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//

namespace DiscUtils.Compression
{
    /// <summary>
    /// Possible results of attempting to compress data.
    /// </summary>
    /// <remarks>
    /// A compression routine <i>may</i> return <c>Compressed</c>, even if the data
    /// was 'all zeros' or increased in size.  The <c>AllZeros</c> and <c>Incompressible</c>
    /// values are for algorithms that include special detection for these cases.
    /// </remarks>
    public enum CompressionResult
    {
        /// <summary>
        /// The data compressed succesfully.
        /// </summary>
        Compressed,

        /// <summary>
        /// The data was all-zero's.
        /// </summary>
        AllZeros,

        /// <summary>
        /// The data was incompressible (could not fit into destination buffer).
        /// </summary>
        Incompressible
    }
}