IDeflateService.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* IDeflateService.h                                           (C) 2000-2025 */
/*                                                                           */
/* Interface of a service allowing compression/decompression of data.        */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_IDEFLATESERVICE_H
#define ARCANE_CORE_IDEFLATESERVICE_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/core/ArcaneTypes.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
// Minimum size (in bytes) for an array to be compressed.
// Below this size, it is not compressed.
// If this size changes, the corresponding size must be changed
// in the VariableComparer in C#.
static const Integer DEFLATE_MIN_SIZE = 512;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT IDeflateService
{
 public:
 
  virtual ~IDeflateService() = default;
 
 public:
 
  virtual void build() = 0;
 
 public:

  ARCANE_DEPRECATED_REASON("Y2023: This interface is deprecated. Use IDataCompressor instead")
  virtual void compress(ByteConstArrayView values, ByteArray& compressed_values) = 0;

  ARCANE_DEPRECATED_REASON("Y2023: This interface is deprecated. Use IDataCompressor instead")
  virtual void compress(Span<const Byte> values, ByteArray& compressed_values);

  ARCANE_DEPRECATED_REASON("Y2023: This interface is deprecated. Use IDataCompressor instead")
  virtual void decompress(ByteConstArrayView compressed_values, ByteArrayView values) = 0;

  ARCANE_DEPRECATED_REASON("Y2023: This interface is deprecated. Use IDataCompressor instead")
  virtual void decompress(Span<const Byte> compressed_values, Span<Byte> values);
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif