File: entry.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (52 lines) | stat: -rw-r--r-- 1,759 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_PERSISTENT_CACHE_ENTRY_H_
#define COMPONENTS_PERSISTENT_CACHE_ENTRY_H_

#include <cstdint>

#include "base/component_export.h"
#include "base/containers/span.h"
#include "components/persistent_cache/entry_metadata.h"

namespace persistent_cache {

// Provides access to a snapshot of the content of an entry. The snapshot
// remains valid and unmodified even if the entry is modified or removed in the
// cache.
class COMPONENT_EXPORT(PERSISTENT_CACHE) Entry {
 public:
  virtual ~Entry() = 0;

  // Not copyable or moveable.
  Entry(const Entry&) = delete;
  Entry(Entry&&) = delete;
  Entry& operator=(const Entry&) = delete;
  Entry& operator=(Entry&&) = delete;

  // Use to acquire a span that is kept valid until this Entry is released. If
  // looking to immediately copy contents prefer `CopyContentTo` which is
  // guaranteed to be equally or more performant.
  virtual base::span<const uint8_t> GetContentSpan() const = 0;

  // Use to copy the content of the entry to `content`.
  virtual size_t CopyContentTo(base::span<uint8_t> content) const;

  // Use to get the size of the entry's value in bytes.
  virtual size_t GetContentSize() const;

  // Use to retrieve metadata tied to the entry. Partially or completely
  // populated by default values if the metadata was not supplied on insert.
  virtual EntryMetadata GetMetadata() const = 0;

 protected:
  // Ownership and liveness is managed by the backend and thus Entry should not
  // be created outside of their scope.
  Entry() = default;
};

}  // namespace persistent_cache

#endif  // COMPONENTS_PERSISTENT_CACHE_ENTRY_H_