Skip to content

Commit c7c5905

Browse files
committed
rename multi methods to partial_values
1 parent 15291b2 commit c7c5905

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

docs/protocol/core/v3.0.rst

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1199,13 +1199,14 @@ available data until the end of the referenced value. For example
11991199
`range` ``[0, none]`` specifies the full value. Stores that do not
12001200
support partial access can still answer the requests using cutouts
12011201
of full values. It is recommended that the implementation of the
1202-
``get_multi``, ``set_multi`` and ``remove_multi`` methods is made
1203-
optional, providing fallbacks for them by default. However, it is
1204-
recommended to supply those operations where possible for efficiency.
1205-
Also, the ``get``, ``set`` and ``erase`` can easily be mapped onto
1206-
their `multi` counterparts. Therefore, it is also recommended to
1207-
supply fallbacks for those if the `multi` operations can be implemented.
1208-
An entity containing those fallbacks could be named ``MultiStore``.
1202+
``get_partial_values``, ``set_partial_values`` and
1203+
``remove_partial_values`` methods is made optional, providing fallbacks
1204+
for them by default. However, it is recommended to supply those operations
1205+
where possible for efficiency. Also, the ``get``, ``set`` and ``erase``
1206+
can easily be mapped onto their `partial_values` counterparts.
1207+
Therefore, it is also recommended to supply fallbacks for those if the
1208+
`partial_values` operations can be implemented.
1209+
An entity containing those fallbacks could be named ``StoreWithPartialAccess``.
12091210

12101211
The store interface also defines some operations involving
12111212
`prefixes`. In the context of this interface, a prefix is a string
@@ -1225,7 +1226,7 @@ A **readable store** supports the following operation:
12251226
| Parameters: `key`
12261227
| Output: `value`
12271228
1228-
``get_multi`` - Retrieve possibly partial `values` from given `key_ranges`.
1229+
``get_partial_values`` - Retrieve possibly partial `values` from given `key_ranges`.
12291230

12301231
| Parameters: `key_ranges`: ordered set of `key`, `range` pairs,
12311232
| a `key` may occur multiple times with different `ranges`
@@ -1238,7 +1239,7 @@ A **writeable store** supports the following operations:
12381239
| Parameters: `key`, `value`
12391240
| Output: none
12401241
1241-
``set_multi`` - Store `values` at a given `key`, starting at byte `range_start`.
1242+
``set_partial_values`` - Store `values` at a given `key`, starting at byte `range_start`.
12421243

12431244
| Parameters: `key_start_values`: set of `key`,
12441245
| `range_start`, `value` triples, a `key` may occur multiple
@@ -1252,7 +1253,7 @@ A **writeable store** supports the following operations:
12521253
| Parameters: `key`
12531254
| Output: none
12541255
1255-
``erase_multi`` - Erase the given key/value pair from the store.
1256+
``remove_partial_values`` - Erase the given key/value pair from the store.
12561257

12571258
| Parameters: `keys`: set of `keys`
12581259
| Output: none

0 commit comments

Comments
 (0)