opendal/types/
capability.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
18use std::fmt::Debug;
19
20/// Capability defines the supported operations and their constraints for a storage Operator.
21///
22/// # Overview
23///
24/// This structure provides a comprehensive description of an Operator's capabilities,
25/// including:
26///
27/// - Basic operations support (read, write, delete, etc.)
28/// - Advanced operation variants (conditional operations, metadata handling)
29/// - Operational constraints (size limits, batch limitations)
30///
31/// # Capability Types
32///
33/// Every operator maintains two capability sets:
34///
35/// 1. [`OperatorInfo::native_capability`][crate::OperatorInfo::native_capability]:
36///    Represents operations natively supported by the storage backend.
37///
38/// 2. [`OperatorInfo::full_capability`][crate::OperatorInfo::full_capability]:
39///    Represents all available operations, including those implemented through
40///    alternative mechanisms.
41///
42/// # Implementation Details
43///
44/// Some operations might be available even when not natively supported by the
45/// backend. For example:
46///
47/// - Blocking operations are provided through the BlockingLayer
48///
49/// Developers should:
50/// - Use `full_capability` to determine available operations
51/// - Use `native_capability` to identify optimized operations
52///
53/// # Field Naming Conventions
54///
55/// Fields follow these naming patterns:
56///
57/// - Basic operations: Simple lowercase (e.g., `read`, `write`)
58/// - Compound operations: Underscore-separated (e.g., `presign_read`)
59/// - Variants: Capability description (e.g., `write_can_empty`)
60/// - Parameterized operations: With-style (e.g., `read_with_if_match`)
61/// - Limitations: Constraint description (e.g., `write_multi_max_size`)
62/// - Metadata Results: Returning metadata capabilities (e.g., `stat_has_content_length`)
63///
64/// All capability fields are public and can be accessed directly.
65#[derive(Copy, Clone, Default)]
66pub struct Capability {
67    /// Indicates if the operator supports metadata retrieval operations.
68    pub stat: bool,
69    /// Indicates if conditional stat operations using If-Match are supported.
70    pub stat_with_if_match: bool,
71    /// Indicates if conditional stat operations using If-None-Match are supported.
72    pub stat_with_if_none_match: bool,
73    /// Indicates if conditional stat operations using If-Modified-Since are supported.
74    pub stat_with_if_modified_since: bool,
75    /// Indicates if conditional stat operations using If-Unmodified-Since are supported.
76    pub stat_with_if_unmodified_since: bool,
77    /// Indicates if Cache-Control header override is supported during stat operations.
78    pub stat_with_override_cache_control: bool,
79    /// Indicates if Content-Disposition header override is supported during stat operations.
80    pub stat_with_override_content_disposition: bool,
81    /// Indicates if Content-Type header override is supported during stat operations.
82    pub stat_with_override_content_type: bool,
83    /// Indicates if versions stat operations are supported.
84    pub stat_with_version: bool,
85    /// Indicates whether cache control information is available in stat response
86    pub stat_has_cache_control: bool,
87    /// Indicates whether content disposition information is available in stat response
88    pub stat_has_content_disposition: bool,
89    /// Indicates whether content length information is available in stat response
90    pub stat_has_content_length: bool,
91    /// Indicates whether content MD5 checksum is available in stat response
92    pub stat_has_content_md5: bool,
93    /// Indicates whether content range information is available in stat response
94    pub stat_has_content_range: bool,
95    /// Indicates whether content type information is available in stat response
96    pub stat_has_content_type: bool,
97    /// Indicates whether content encoding information is available in stat response
98    pub stat_has_content_encoding: bool,
99    /// Indicates whether entity tag is available in stat response
100    pub stat_has_etag: bool,
101    /// Indicates whether last modified timestamp is available in stat response
102    pub stat_has_last_modified: bool,
103    /// Indicates whether version information is available in stat response
104    pub stat_has_version: bool,
105    /// Indicates whether user-defined metadata is available in stat response
106    pub stat_has_user_metadata: bool,
107
108    /// Indicates if the operator supports read operations.
109    pub read: bool,
110    /// Indicates if conditional read operations using If-Match are supported.
111    pub read_with_if_match: bool,
112    /// Indicates if conditional read operations using If-None-Match are supported.
113    pub read_with_if_none_match: bool,
114    /// Indicates if conditional read operations using If-Modified-Since are supported.
115    pub read_with_if_modified_since: bool,
116    /// Indicates if conditional read operations using If-Unmodified-Since are supported.
117    pub read_with_if_unmodified_since: bool,
118    /// Indicates if Cache-Control header override is supported during read operations.
119    pub read_with_override_cache_control: bool,
120    /// Indicates if Content-Disposition header override is supported during read operations.
121    pub read_with_override_content_disposition: bool,
122    /// Indicates if Content-Type header override is supported during read operations.
123    pub read_with_override_content_type: bool,
124    /// Indicates if versions read operations are supported.
125    pub read_with_version: bool,
126
127    /// Indicates if the operator supports write operations.
128    pub write: bool,
129    /// Indicates if multiple write operations can be performed on the same object.
130    pub write_can_multi: bool,
131    /// Indicates if writing empty content is supported.
132    pub write_can_empty: bool,
133    /// Indicates if append operations are supported.
134    pub write_can_append: bool,
135    /// Indicates if Content-Type can be specified during write operations.
136    pub write_with_content_type: bool,
137    /// Indicates if Content-Disposition can be specified during write operations.
138    pub write_with_content_disposition: bool,
139    /// Indicates if Content-Encoding can be specified during write operations.
140    pub write_with_content_encoding: bool,
141    /// Indicates if Cache-Control can be specified during write operations.
142    pub write_with_cache_control: bool,
143    /// Indicates if conditional write operations using If-Match are supported.
144    pub write_with_if_match: bool,
145    /// Indicates if conditional write operations using If-None-Match are supported.
146    pub write_with_if_none_match: bool,
147    /// Indicates if write operations can be conditional on object non-existence.
148    pub write_with_if_not_exists: bool,
149    /// Indicates if custom user metadata can be attached during write operations.
150    pub write_with_user_metadata: bool,
151    /// Maximum size supported for multipart uploads.
152    /// For example, AWS S3 supports up to 5GiB per part in multipart uploads.
153    pub write_multi_max_size: Option<usize>,
154    /// Minimum size required for multipart uploads (except for the last part).
155    /// For example, AWS S3 requires at least 5MiB per part.
156    pub write_multi_min_size: Option<usize>,
157    /// Maximum total size supported for write operations.
158    /// For example, Cloudflare D1 has a 1MB total size limit.
159    pub write_total_max_size: Option<usize>,
160
161    /// Indicates if directory creation is supported.
162    pub create_dir: bool,
163
164    /// Indicates if delete operations are supported.
165    pub delete: bool,
166    /// Indicates if versions delete operations are supported.
167    pub delete_with_version: bool,
168    /// Maximum size supported for single delete operations.
169    pub delete_max_size: Option<usize>,
170
171    /// Indicates if copy operations are supported.
172    pub copy: bool,
173
174    /// Indicates if rename operations are supported.
175    pub rename: bool,
176
177    /// Indicates if list operations are supported.
178    pub list: bool,
179    /// Indicates if list operations support result limiting.
180    pub list_with_limit: bool,
181    /// Indicates if list operations support continuation from a specific point.
182    pub list_with_start_after: bool,
183    /// Indicates if recursive listing is supported.
184    pub list_with_recursive: bool,
185    /// Indicates if versions listing is supported.
186    #[deprecated(since = "0.51.1", note = "use with_versions instead")]
187    pub list_with_version: bool,
188    /// Indicates if listing with versions included is supported.
189    pub list_with_versions: bool,
190    /// Indicates if listing with deleted files included is supported.
191    pub list_with_deleted: bool,
192    /// Indicates whether cache control information is available in list response
193    pub list_has_cache_control: bool,
194    /// Indicates whether content disposition information is available in list response
195    pub list_has_content_disposition: bool,
196    /// Indicates whether content length information is available in list response
197    pub list_has_content_length: bool,
198    /// Indicates whether content MD5 checksum is available in list response
199    pub list_has_content_md5: bool,
200    /// Indicates whether content range information is available in list response
201    pub list_has_content_range: bool,
202    /// Indicates whether content type information is available in list response
203    pub list_has_content_type: bool,
204    /// Indicates whether entity tag is available in list response
205    pub list_has_etag: bool,
206    /// Indicates whether last modified timestamp is available in list response
207    pub list_has_last_modified: bool,
208    /// Indicates whether version information is available in list response
209    pub list_has_version: bool,
210    /// Indicates whether user-defined metadata is available in list response
211    pub list_has_user_metadata: bool,
212
213    /// Indicates if presigned URL generation is supported.
214    pub presign: bool,
215    /// Indicates if presigned URLs for read operations are supported.
216    pub presign_read: bool,
217    /// Indicates if presigned URLs for stat operations are supported.
218    pub presign_stat: bool,
219    /// Indicates if presigned URLs for write operations are supported.
220    pub presign_write: bool,
221    /// Indicates if presigned URLs for delete operations are supported.
222    pub presign_delete: bool,
223
224    /// Indicate if the operator supports shared access.
225    pub shared: bool,
226
227    /// Indicates if blocking operations are supported.
228    pub blocking: bool,
229}
230
231impl Debug for Capability {
232    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
233        // NOTE: All services in opendal are readable.
234        if self.read {
235            f.write_str("Read")?;
236        }
237        if self.write {
238            f.write_str("| Write")?;
239        }
240        if self.list {
241            f.write_str("| List")?;
242        }
243        if self.presign {
244            f.write_str("| Presign")?;
245        }
246        if self.shared {
247            f.write_str("| Shared")?;
248        }
249        if self.blocking {
250            f.write_str("| Blocking")?;
251        }
252        Ok(())
253    }
254}
opendal/types/capability.rs

opendal/types/
capability.rs
