summaryrefslogtreecommitdiff
path: root/chromium/components/offline_pages/core/offline_store_types.h
blob: 77d6a6a9bdf7a8286f6f5b1b271df1395c46c649 (plain)
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
53
54
55
56
57
58
59
60
// Copyright 2016 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_OFFLINE_PAGES_CORE_OFFLINE_STORE_TYPES_H_
#define COMPONENTS_OFFLINE_PAGES_CORE_OFFLINE_STORE_TYPES_H_

#include <stdint.h>

#include <utility>
#include <vector>

// This file contains common types and callbacks used by storage of various
// offline page related components.
namespace offline_pages {

// TODO(fgorski): This enum is meant to replace |LoadStatus|.
// Current store state. When LOADED, the store is operational. When
// loading or reset fails, it is reflected appropriately.
enum class StoreState {
  NOT_LOADED,      // Store is not loaded yet.
  LOADED,          // Store is properly loaded and operational.
  FAILED_LOADING,  // Store initialization failed.
  FAILED_RESET,    // Resetting the store failed.
};

// Statuses referring to actions taken on items in the stores.
// GENERATED_JAVA_ENUM_PACKAGE:org.chromium.components.offlinepages
enum class ItemActionStatus {
  SUCCESS,
  ALREADY_EXISTS,
  NOT_FOUND,
  STORE_ERROR,
};

// List of item action statuses mapped to item ID.
typedef std::vector<std::pair<int64_t, ItemActionStatus>> MultipleItemStatuses;

// Collective result for store update.
template <typename T>
class StoreUpdateResult {
 public:
  explicit StoreUpdateResult(StoreState state) : store_state(state) {}
  ~StoreUpdateResult() {}

  // List of Offline ID to item action status mappings.
  // It is meant to be consumed by the original caller of the operation.
  MultipleItemStatuses item_statuses;

  // List of successfully updated offline page items as seen after operation
  // concludes. It is meant to be used when passing to the observers.
  std::vector<T> updated_items;

  // State of the store after the operation is done.
  StoreState store_state;
};

}  // namespace offline_pages

#endif  // COMPONENTS_OFFLINE_PAGES_CORE_OFFLINE_STORE_TYPES_H_