summaryrefslogtreecommitdiff
path: root/chromium/third_party/libaddressinput/src/cpp/include/libaddressinput/storage.h
blob: 94ad13bdd20b45c3a4a2c8256df34456f98b87f6 (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
61
62
63
64
// Copyright (C) 2013 Google Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// The interface to be implemented by the user of the library to enable storing
// address metadata (e.g. on disk).

#ifndef I18N_ADDRESSINPUT_STORAGE_H_
#define I18N_ADDRESSINPUT_STORAGE_H_

#include <libaddressinput/callback.h>

#include <string>

namespace i18n {
namespace addressinput {

// Stores address metadata. The data must be allocated on the heap, passing
// ownership to the called function. Sample usage:
//
//    class MyStorage : public Storage {
//     public:
//      virtual void Put(const std::string& key, std::string* data) {
//        ...
//        delete data;
//      }
//
//      virtual void Get(const std::string& key,
//                       const Callback& data_ready) const {
//        bool success = ...
//        std::string* data = new ...
//        data_ready(success, key, data);
//      }
//    };
class Storage {
 public:
  typedef i18n::addressinput::Callback<const std::string&,
                                       std::string*> Callback;

  virtual ~Storage() {}

  // Stores |data| for |key|, where |data| is an object allocated on the heap,
  // which Storage takes ownership of.
  virtual void Put(const std::string& key, std::string* data) = 0;

  // Retrieves the data for |key| and invokes the |data_ready| callback.
  virtual void Get(const std::string& key,
                   const Callback& data_ready) const = 0;
};

}  // namespace addressinput
}  // namespace i18n

#endif  // I18N_ADDRESSINPUT_STORAGE_H_