ISerializedData.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* ISerializedData.h                                           (C) 2000-2025 */
/*                                                                           */
/* Interface of a serialized data.                                           */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_ISERIALIZEDDATA_H
#define ARCANE_CORE_ISERIALIZEDDATA_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/core/ArcaneTypes.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT ISerializedData
{
  ARCCORE_DECLARE_REFERENCE_COUNTED_INCLASS_METHODS();
 
 public:

  virtual ~ISerializedData() = default;
 
 public:

  virtual eDataType baseDataType() const = 0;

  virtual Integer nbDimension() const = 0;

  virtual Int64 nbElement() const = 0;

  virtual Int64 nbBaseElement() const = 0;

  virtual bool isMultiSize() const = 0;

  virtual Int64 memorySize() const = 0;

  virtual Int64ConstArrayView extents() const = 0;

  virtual ArrayShape shape() const = 0;

  virtual Span<const Byte> constBytes() const = 0;

  virtual Span<Byte> writableBytes() = 0;

  virtual void setWritableBytes(Span<Byte> bytes) = 0;

  virtual void setConstBytes(Span<const Byte> bytes) = 0;

  virtual void allocateMemory(Int64 size) = 0;
 
 public:

  virtual void serialize(ISerializer* buffer) = 0;

  virtual void serialize(ISerializer* buffer) const = 0;
 
 public:

  virtual void computeHash(IHashAlgorithm* algo, ByteArray& output) const = 0;
 
 public:

  ARCANE_DEPRECATED_2018_R("Use method 'writableBytes()' or 'constBytes()' instead")
  virtual ByteConstArrayView buffer() const = 0;

  ARCANE_DEPRECATED_2018_R("Use method 'writableBytes()' or 'constBytes()' instead")
  virtual ByteArrayView buffer() = 0;

  ARCCORE_DEPRECATED_2021("Use method 'writableBytes()' or 'constBytes()' instead")
  virtual Span<const Byte> bytes() const = 0;

  ARCCORE_DEPRECATED_2021("Use method 'setWritableBytes()' instead")
  virtual void setBuffer(ByteArrayView buffer) = 0;

  ARCCORE_DEPRECATED_2021("Use method 'setConstBytes()' instead")
  virtual void setBuffer(ByteConstArrayView buffer) = 0;

  ARCCORE_DEPRECATED_2021("Use method 'setWritableBytes()' instead")
  virtual void setBytes(Span<Byte> bytes) = 0;

  ARCCORE_DEPRECATED_2021("Use method 'setConstBytes()' instead")
  virtual void setBytes(Span<const Byte> bytes) = 0;

  ARCCORE_DEPRECATED_2021("Use method 'writableBytes()' or 'constBytes()' instead")
  virtual Span<Byte> bytes() = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

extern "C++" ARCANE_CORE_EXPORT
Ref<ISerializedData>
arcaneCreateSerializedDataRef(eDataType data_type, Int64 memory_size,
                              Integer nb_dim, Int64 nb_element, Int64 nb_base_element,
                              bool is_multi_size, Int64ConstArrayView dimensions);
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

extern "C++" ARCANE_CORE_EXPORT
Ref<ISerializedData>
arcaneCreateSerializedDataRef(eDataType data_type, Int64 memory_size,
                              Integer nb_dim, Int64 nb_element, Int64 nb_base_element,
                              bool is_multi_size, Int64ConstArrayView dimensions,
                              const ArrayShape& shape);
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

extern "C++" ARCANE_CORE_EXPORT
Ref<ISerializedData>
arcaneCreateEmptySerializedDataRef();
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif