opendal_core/docs/rfcs/
mod.rs

1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements.  See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership.  The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License.  You may obtain a copy of the License at
8//
9//   http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied.  See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18#![doc = include_str!("README.md")]
19
20/// RFC example
21#[doc = include_str!("0000_example.md")]
22pub mod rfc_0000_example {}
23
24/// Compact metadata and operation arguments
25#[doc = include_str!("8194_compact_metadata_and_operation_args.md")]
26pub mod rfc_8194_compact_metadata_and_operation_args {}
27
28/// Write if not changed
29#[doc = include_str!("8147_write_if_not_changed.md")]
30pub mod rfc_8147_write_if_not_changed {}
31
32/// Object native API
33#[doc = include_str!("0041_object_native_api.md")]
34pub mod rfc_0041_object_native_api {}
35
36/// Error handle
37#[doc = include_str!("0044_error_handle.md")]
38pub mod rfc_0044_error_handle {}
39
40/// Auto region
41#[doc = include_str!("0057_auto_region.md")]
42pub mod rfc_0057_auto_region {}
43
44/// Object stream
45#[doc = include_str!("0069_object_stream.md")]
46pub mod rfc_0069_object_stream {}
47
48/// Limited reader
49#[doc = include_str!("0090_limited_reader.md")]
50pub mod rfc_0090_limited_reader {}
51
52/// Path normalization
53#[doc = include_str!("0112_path_normalization.md")]
54pub mod rfc_0112_path_normalization {}
55
56/// Async streaming IO
57#[doc = include_str!("0191_async_streaming_io.md")]
58pub mod rfc_0191_async_streaming_io {}
59
60/// Remove credential
61#[doc = include_str!("0203_remove_credential.md")]
62pub mod rfc_0203_remove_credential {}
63
64/// Create dir
65#[doc = include_str!("0221_create_dir.md")]
66pub mod rfc_0221_create_dir {}
67
68/// Retryable error
69#[doc = include_str!("0247_retryable_error.md")]
70pub mod rfc_0247_retryable_error {}
71
72/// Object ID
73#[doc = include_str!("0293_object_id.md")]
74pub mod rfc_0293_object_id {}
75
76/// Dir entry
77#[doc = include_str!("0337_dir_entry.md")]
78pub mod rfc_0337_dir_entry {}
79
80/// Accessor capabilities
81#[doc = include_str!("0409_accessor_capabilities.md")]
82pub mod rfc_0409_accessor_capabilities {}
83
84/// Presign
85#[doc = include_str!("0413_presign.md")]
86pub mod rfc_0413_presign {}
87
88/// Command line interface
89#[doc = include_str!("0423_command_line_interface.md")]
90pub mod rfc_0423_command_line_interface {}
91
92/// Init from iter
93#[doc = include_str!("0429_init_from_iter.md")]
94pub mod rfc_0429_init_from_iter {}
95
96/// Multipart
97#[doc = include_str!("0438_multipart.md")]
98pub mod rfc_0438_multipart {}
99
100/// Gateway
101#[doc = include_str!("0443_gateway.md")]
102pub mod rfc_0443_gateway {}
103
104/// New builder
105#[doc = include_str!("0501_new_builder.md")]
106pub mod rfc_0501_new_builder {}
107
108/// Write refactor
109#[doc = include_str!("0554_write_refactor.md")]
110pub mod rfc_0554_write_refactor {}
111
112/// List metadata reuse
113#[doc = include_str!("0561_list_metadata_reuse.md")]
114pub mod rfc_0561_list_metadata_reuse {}
115
116/// Blocking API
117#[doc = include_str!("0599_blocking_api.md")]
118pub mod rfc_0599_blocking_api {}
119
120/// Redis service
121#[doc = include_str!("0623_redis_service.md")]
122pub mod rfc_0623_redis_service {}
123
124/// Split capabilities
125#[doc = include_str!("0627_split_capabilities.md")]
126pub mod rfc_0627_split_capabilities {}
127
128/// Path in accessor
129#[doc = include_str!("0661_path_in_accessor.md")]
130pub mod rfc_0661_path_in_accessor {}
131
132/// Generic KV services
133#[doc = include_str!("0793_generic_kv_services.md")]
134pub mod rfc_0793_generic_kv_services {}
135
136/// Object reader
137#[doc = include_str!("0926_object_reader.md")]
138pub mod rfc_0926_object_reader {}
139
140/// Refactor error
141#[doc = include_str!("0977_refactor_error.md")]
142pub mod rfc_0977_refactor_error {}
143
144/// Object handler
145#[doc = include_str!("1085_object_handler.md")]
146pub mod rfc_1085_object_handler {}
147
148/// Object metadataer
149#[doc = include_str!("1391_object_metadataer.md")]
150pub mod rfc_1391_object_metadataer {}
151
152/// Query based metadata
153#[doc = include_str!("1398_query_based_metadata.md")]
154pub mod rfc_1398_query_based_metadata {}
155
156/// Object writer
157#[doc = include_str!("1420_object_writer.md")]
158pub mod rfc_1420_object_writer {}
159
160/// Remove object concept
161#[doc = include_str!("1477_remove_object_concept.md")]
162pub mod rfc_1477_remove_object_concept {}
163
164/// Operation extension
165#[doc = include_str!("1735_operation_extension.md")]
166pub mod rfc_1735_operation_extension {}
167
168/// Writer sink API
169#[doc = include_str!("2083_writer_sink_api.md")]
170pub mod rfc_2083_writer_sink_api {}
171
172/// Append API
173#[doc = include_str!("2133_append_api.md")]
174pub mod rfc_2133_append_api {}
175
176/// Chain based operator API
177#[doc = include_str!("2299_chain_based_operator_api.md")]
178pub mod rfc_2299_chain_based_operator_api {}
179
180/// Object versioning
181#[doc = include_str!("2602_object_versioning.md")]
182pub mod rfc_2602_object_versioning {}
183
184/// Merge append into write
185#[doc = include_str!("2758_merge_append_into_write.md")]
186pub mod rfc_2758_merge_append_into_write {}
187
188/// Lister API
189#[doc = include_str!("2774_lister_api.md")]
190pub mod rfc_2774_lister_api {}
191
192/// List with metakey
193#[doc = include_str!("2779_list_with_metakey.md")]
194pub mod rfc_2779_list_with_metakey {}
195
196/// Native capability
197#[doc = include_str!("2852_native_capability.md")]
198pub mod rfc_2852_native_capability {}
199
200/// Remove write copy from
201#[doc = include_str!("3017_remove_write_copy_from.md")]
202pub mod rfc_3017_remove_write_copy_from {}
203
204/// Config
205#[doc = include_str!("3197_config.md")]
206pub mod rfc_3197_config {}
207
208/// Align list API
209#[doc = include_str!("3232_align_list_api.md")]
210pub mod rfc_3232_align_list_api {}
211
212/// List prefix
213#[doc = include_str!("3243_list_prefix.md")]
214pub mod rfc_3243_list_prefix {}
215
216/// Lazy reader
217#[doc = include_str!("3356_lazy_reader.md")]
218pub mod rfc_3356_lazy_reader {}
219
220/// List recursive
221#[doc = include_str!("3526_list_recursive.md")]
222pub mod rfc_3526_list_recursive {}
223
224/// Concurrent stat in list
225#[doc = include_str!("3574_concurrent_stat_in_list.md")]
226pub mod rfc_3574_concurrent_stat_in_list {}
227
228/// Buffered Reader
229#[doc = include_str!("3734_buffered_reader.md")]
230pub mod rfc_3734_buffered_reader {}
231
232/// Concurrent Writer
233#[doc = include_str!("3898_concurrent_writer.md")]
234pub mod rfc_3898_concurrent_writer {}
235
236/// Deleter API
237#[doc = include_str!("3911_deleter_api.md")]
238pub mod rfc_3911_deleter_api {}
239
240/// Range Based Read API
241#[doc = include_str!("4382_range_based_read.md")]
242pub mod rfc_4382_range_based_read {}
243
244/// Executor API
245#[doc = include_str!("4638_executor.md")]
246pub mod rfc_4638_executor {}
247
248/// Remove metakey
249#[doc = include_str!("5314_remove_metakey.md")]
250pub mod rfc_5314_remove_metakey {}
251
252/// Operator from uri
253#[doc = include_str!("5444_operator_from_uri.md")]
254pub mod rfc_5444_operator_from_uri {}
255
256/// Context
257#[doc = include_str!("5479_context.md")]
258pub mod rfc_5479_context {}
259
260/// Conditional Reader
261#[doc = include_str!("5485_conditional_reader.md")]
262pub mod rfc_5485_conditional_reader {}
263
264/// List With Deleted
265#[doc = include_str!("5495_list_with_deleted.md")]
266pub mod rfc_5495_list_with_deleted {}
267
268/// Write Returns Metadata
269#[doc = include_str!("5556_write_returns_metadata.md")]
270pub mod rfc_5556_write_returns_metadata {}
271
272/// Read Returns Metadata
273#[doc = include_str!("5871_read_returns_metadata.md")]
274pub mod rfc_5871_read_returns_metadata {}
275
276/// Remove Native Blocking
277#[doc = include_str!("6189_remove_native_blocking.md")]
278pub mod rfc_6189_remove_native_blocking {}
279
280/// Glob support
281#[doc = include_str!("6209_glob_support.md")]
282pub mod rfc_6209_glob_support {}
283
284/// Options API
285#[doc = include_str!("6213_options_api.md")]
286pub mod rfc_6213_options_api {}
287
288/// Cache Layer
289#[doc = include_str!("6297_cache_layer.md")]
290pub mod rfc_6297_cache_layer {}
291
292/// Simulate Layer
293#[doc = include_str!("6678_simulate_layer.md")]
294pub mod rfc_6678_simulate_layer {}
295
296/// Capability Override Layer
297#[doc = include_str!("6707_capability_override_layer.md")]
298pub mod rfc_6707_capability_override_layer {}
299
300/// Checksum
301#[doc = include_str!("6817_checksum.md")]
302pub mod rfc_6817_checksum {}
303
304/// Core
305#[doc = include_str!("6828_core.md")]
306pub mod rfc_6828_core {}
307
308/// Route Layer
309#[doc = include_str!("7130_route_layer.md")]
310pub mod rfc_7130_route_layer {}
311
312/// Copier API
313#[doc = include_str!("7519_copier_api.md")]
314pub mod rfc_7519_copier_api {}
315
316/// Move Read Range To Reader
317#[doc = include_str!("7660_move_read_range_to_reader.md")]
318pub mod rfc_7660_move_read_range_to_reader {}
319
320/// Capability API
321#[doc = include_str!("7700_capability_api.md")]
322pub mod rfc_7700_capability_api {}
323
324/// Operator Composition
325#[doc = include_str!("7740_operator_composition.md")]
326pub mod rfc_7740_operator_composition {}
327
328/// Simplify Stateful Operation Factory
329#[doc = include_str!("7744_simplify_stateful_operation_factory.md")]
330pub mod rfc_7744_simplify_stateful_operation_factory {}
331
332/// HTTP Transporter
333#[doc = include_str!("7749_http_transporter.md")]
334pub mod rfc_7749_http_transporter {}
335
336/// Rename If Not Exists
337#[doc = include_str!("7818_rename_if_not_exists.md")]
338pub mod rfc_7818_rename_if_not_exists {}
339
340/// Limited Read
341#[doc = include_str!("7945_limited_read.md")]
342pub mod rfc_7945_limited_read {}
343
344/// S3 Provider Presets
345#[doc = include_str!("7948_s3_provider_presets.md")]
346pub mod rfc_7948_s3_provider_presets {}
347
348/// Writer Copy From
349#[doc = include_str!("8109_writer_copy_from.md")]
350pub mod rfc_8109_writer_copy_from {}
351
352/// Conflict Error Kind
353#[doc = include_str!("8145_conflict_error_kind.md")]
354pub mod rfc_8145_conflict_error_kind {}
opendal_core/docs/rfcs/mod.rs

opendal_core/docs/rfcs/
mod.rs
