blob: 6d603b8ccaa54d0e389a72edb618edaeb8c145bd (
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
#pragma once
#include <memory>
#include <string>
namespace mbgl {
/**
* @brief Holds values for resource options.
*/
class ResourceOptions final {
public:
/**
* @brief Constructs a ResourceOptions object with default values.
*/
ResourceOptions();
~ResourceOptions();
ResourceOptions(ResourceOptions&&) noexcept;
ResourceOptions clone() const;
/**
* @brief Sets the Mapbox access token - see https://docs.mapbox.com/help/how-mapbox-works/access-tokens/ for details.
*
* @param token Mapbox access token.
* @return ResourceOptions for chaining options together.
*/
ResourceOptions& withAccessToken(std::string token);
/**
* @brief Gets the previously set (or default) Mapbox access token.
*
* @return const std::string& Mapbox access token.
*/
const std::string& accessToken() const;
/**
* @brief Sets the API base URL. Default is https://api.mapbox.com for Mapbox.
*
* @param baseURL API base URL.
* @return ResourceOptions for chaining options together.
*/
ResourceOptions& withBaseURL(std::string baseURL);
/**
* @brief Gets the previously set (or default) API base URL.
*
* @return const std::string& API base URL.
*/
const std::string& baseURL() const;
/**
* @brief Sets the cache path.
*
* @param path Cache path.
* @return ResourceOptions for chaining options together.
*/
ResourceOptions& withCachePath(std::string path);
/**
* @brief Gets the previously set (or default) cache path.
*
* @return cache path
*/
const std::string& cachePath() const;
/**
* @brief Sets the asset path, which is the root directory from where
* the asset:// scheme gets resolved in a style.
*
* @param path Asset path.
* @return ResourceOptions for chaining options together.
*/
ResourceOptions& withAssetPath(std::string path);
/**
* @brief Gets the previously set (or default) asset path.
*
* @return asset path
*/
const std::string& assetPath() const;
/**
* @brief Sets the maximum cache size.
*
* @param size Cache maximum size in bytes.
* @return reference to ResourceOptions for chaining options together.
*/
ResourceOptions& withMaximumCacheSize(uint64_t size);
/**
* @brief Gets the previously set (or default) maximum allowed cache size.
*
* @return maximum allowed cache database size in bytes.
*/
uint64_t maximumCacheSize() const;
/**
* @brief Sets the platform context. A platform context is usually an object
* that assists the creation of a file source.
*
* @param context Platform context.
* @return reference to ResourceOptions for chaining options together.
*/
ResourceOptions& withPlatformContext(void* context);
/**
* @brief Gets the previously set (or default) platform context.
*
* @return Platform context.
*/
void* platformContext() const;
private:
ResourceOptions(const ResourceOptions&);
class Impl;
std::unique_ptr<Impl> impl_;
};
} // namespace mbgl
|
