Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
FileContent.h
1// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
2//-----------------------------------------------------------------------------
3// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
4// See the top-level COPYRIGHT file for details.
5// SPDX-License-Identifier: Apache-2.0
6//-----------------------------------------------------------------------------
7/*---------------------------------------------------------------------------*/
8/* FileContent.h (C) 2000-2019 */
9/* */
10/* File content. */
11/*---------------------------------------------------------------------------*/
12#ifndef ARCANE_UTILS_FILECONTENT_H
13#define ARCANE_UTILS_FILECONTENT_H
14/*---------------------------------------------------------------------------*/
15/*---------------------------------------------------------------------------*/
16
17#include "arcane/utils/Array.h"
18#include "arcane/utils/String.h"
19
20/*---------------------------------------------------------------------------*/
21/*---------------------------------------------------------------------------*/
22
23namespace Arcane
24{
25
26/*---------------------------------------------------------------------------*/
27/*---------------------------------------------------------------------------*/
28
29/*!
30 * \brief Description and content of a file.
31 */
32class ARCANE_UTILS_EXPORT FileContent
33{
34 public:
35
36 static const Int32 CURRENT_VERSION = 1;
37
38 public:
39
40 //! Creates empty content.
41 FileContent()
42 : m_version(CURRENT_VERSION)
43 {}
44 FileContent(Span<const Byte> abytes, Int32 version, const String& compression)
45 : m_bytes(abytes)
46 , m_version(version)
47 , m_compression(compression)
48 {}
49
50 public:
51
52 //! File content
53 Span<const Byte> bytes() const;
54 //! Content version
55 Int32 version() const { return m_version; }
56 //! Compression algorithm used.
57 const String& compression() const { return m_compression; }
58
59 private:
60
61 UniqueArray<Byte> m_bytes;
62 Int32 m_version;
63 String m_compression;
64};
65
66/*---------------------------------------------------------------------------*/
67/*---------------------------------------------------------------------------*/
68
69} // End namespace Arcane
70
71/*---------------------------------------------------------------------------*/
72/*---------------------------------------------------------------------------*/
73
74#endif
Arcane::FileContent
Description and content of a file.
Definition FileContent.h:33
Arcane::FileContent::compression
const String & compression() const
Compression algorithm used.
Definition FileContent.h:57
Arcane::FileContent::version
Int32 version() const
Content version.
Definition FileContent.h:55
Arcane::FileContent::FileContent
FileContent()
Creates empty content.
Definition FileContent.h:41
Arcane::Span
View of an array of elements of type T.
Definition Span.h:635
Arcane::UniqueArray
1D data vector with value semantics (STL style).
Definition arccore/src/common/arccore/common/Array.h:890
Arcane
-- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature --
Definition AbstractCaseDocumentVisitor.cc:21
Arcane::Int32
std::int32_t Int32
Signed integer type of 32 bits.
Definition ArccoreGlobal.h:233