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 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you 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.
//! Functions provides the functions generated by [`BlockingOperator`]
//!
//! By using functions, users can add more options for operation.
use std::ops::RangeBounds;
use bytes::Bytes;
use flagset::FlagSet;
use crate::raw::*;
use crate::*;
/// OperatorFunction is the function generated by [`BlockingOperator`].
///
/// The function will consume all the input to generate a result.
pub(crate) struct OperatorFunction<T, R> {
inner: Accessor,
path: String,
args: T,
f: fn(Accessor, String, T) -> Result<R>,
}
impl<T, R> OperatorFunction<T, R> {
pub fn new(
inner: Accessor,
path: String,
args: T,
f: fn(Accessor, String, T) -> Result<R>,
) -> Self {
Self {
inner,
path,
args,
f,
}
}
fn map_args(self, f: impl FnOnce(T) -> T) -> Self {
Self {
inner: self.inner,
path: self.path,
args: f(self.args),
f: self.f,
}
}
fn call(self) -> Result<R> {
(self.f)(self.inner, self.path, self.args)
}
}
/// Function that generated by [`BlockingOperator::write_with`].
///
/// Users can add more options by public functions provided by this struct.
pub struct FunctionWrite(
/// The args for FunctionWrite is a bit special because we also
/// need to move the bytes input this function.
pub(crate) OperatorFunction<(OpWrite, Bytes), ()>,
);
impl FunctionWrite {
/// Set the append mode of op.
///
/// If the append mode is set, the data will be appended to the end of the file.
///
/// # Notes
///
/// Service could return `Unsupported` if the underlying storage does not support append.
pub fn append(mut self, v: bool) -> Self {
self.0 = self.0.map_args(|(args, bs)| (args.with_append(v), bs));
self
}
/// Set the chunk size of op.
///
/// If chunk size is set, the data will be chunked by the underlying writer.
///
/// ## NOTE
///
/// Service could have their own minimum chunk size while perform write operations like
/// multipart uploads. So the chunk size may be larger than the given chunk size.
pub fn chunk(mut self, v: usize) -> Self {
self.0 = self.0.map_args(|(args, bs)| (args.with_chunk(v), bs));
self
}
/// Set the content type of option
pub fn content_type(mut self, v: &str) -> Self {
self.0 = self
.0
.map_args(|(args, bs)| (args.with_content_type(v), bs));
self
}
/// Set the content disposition of option
pub fn content_disposition(mut self, v: &str) -> Self {
self.0 = self
.0
.map_args(|(args, bs)| (args.with_content_disposition(v), bs));
self
}
/// Set the content type of option
pub fn cache_control(mut self, v: &str) -> Self {
self.0 = self
.0
.map_args(|(args, bs)| (args.with_cache_control(v), bs));
self
}
/// Call the function to consume all the input and generate a
/// result.
pub fn call(self) -> Result<()> {
self.0.call()
}
}
/// Function that generated by [`BlockingOperator::writer_with`].
///
/// Users can add more options by public functions provided by this struct.
pub struct FunctionWriter(
/// The args for FunctionWriter is a bit special because we also
/// need to move the bytes input this function.
pub(crate) OperatorFunction<OpWrite, BlockingWriter>,
);
impl FunctionWriter {
/// Set the append mode of op.
///
/// If the append mode is set, the data will be appended to the end of the file.
///
/// # Notes
///
/// Service could return `Unsupported` if the underlying storage does not support append.
pub fn append(mut self, v: bool) -> Self {
self.0 = self.0.map_args(|args| args.with_append(v));
self
}
/// Set the buffer size of op.
///
/// If buffer size is set, the data will be buffered by the underlying writer.
///
/// ## NOTE
///
/// Service could have their own minimum buffer size while perform write operations like
/// multipart uploads. So the buffer size may be larger than the given buffer size.
pub fn buffer(mut self, v: usize) -> Self {
self.0 = self.0.map_args(|args| args.with_chunk(v));
self
}
/// Set the content type of option
pub fn content_type(mut self, v: &str) -> Self {
self.0 = self.0.map_args(|args| args.with_content_type(v));
self
}
/// Set the content disposition of option
pub fn content_disposition(mut self, v: &str) -> Self {
self.0 = self.0.map_args(|args| args.with_content_disposition(v));
self
}
/// Set the content type of option
pub fn cache_control(mut self, v: &str) -> Self {
self.0 = self.0.map_args(|args| args.with_cache_control(v));
self
}
/// Call the function to consume all the input and generate a
/// result.
pub fn call(self) -> Result<BlockingWriter> {
self.0.call()
}
}
/// Function that generated by [`BlockingOperator::delete_with`].
///
/// Users can add more options by public functions provided by this struct.
pub struct FunctionDelete(pub(crate) OperatorFunction<OpDelete, ()>);
impl FunctionDelete {
/// Set the version for this operation.
pub fn version(mut self, v: &str) -> Self {
self.0 = self.0.map_args(|args| args.with_version(v));
self
}
/// Call the function to consume all the input and generate a
/// result.
pub fn call(self) -> Result<()> {
self.0.call()
}
}
/// Function that generated by [`BlockingOperator::list_with`].
///
/// Users can add more options by public functions provided by this struct.
pub struct FunctionList(pub(crate) OperatorFunction<OpList, Vec<Entry>>);
impl FunctionList {
/// The limit passed to underlying service to specify the max results
/// that could return per-request.
///
/// Users could use this to control the memory usage of list operation.
pub fn limit(mut self, v: usize) -> Self {
self.0 = self.0.map_args(|args| args.with_limit(v));
self
}
/// The start_after passes to underlying service to specify the specified key
/// to start listing from.
pub fn start_after(mut self, v: &str) -> Self {
self.0 = self.0.map_args(|args| args.with_start_after(v));
self
}
/// The recursive is used to control whether the list operation is recursive.
///
/// - If `false`, list operation will only list the entries under the given path.
/// - If `true`, list operation will list all entries that starts with given path.
///
/// Default to `false`.
pub fn recursive(mut self, v: bool) -> Self {
self.0 = self.0.map_args(|args| args.with_recursive(v));
self
}
/// Metakey is used to control which meta should be returned.
///
/// Lister will make sure the result for specified meta is **known**:
///
/// - `Some(v)` means exist.
/// - `None` means services doesn't have this meta.
///
/// The default metakey is `Metakey::Mode`.
pub fn metakey(mut self, v: impl Into<FlagSet<Metakey>>) -> Self {
self.0 = self.0.map_args(|args| args.with_metakey(v));
self
}
/// Call the function to consume all the input and generate a
/// result.
pub fn call(self) -> Result<Vec<Entry>> {
self.0.call()
}
}
/// Function that generated by [`BlockingOperator::lister_with`].
///
/// Users can add more options by public functions provided by this struct.
pub struct FunctionLister(pub(crate) OperatorFunction<OpList, BlockingLister>);
impl FunctionLister {
/// The limit passed to underlying service to specify the max results
/// that could return per-request.
///
/// Users could use this to control the memory usage of list operation.
pub fn limit(mut self, v: usize) -> Self {
self.0 = self.0.map_args(|args| args.with_limit(v));
self
}
/// The start_after passes to underlying service to specify the specified key
/// to start listing from.
pub fn start_after(mut self, v: &str) -> Self {
self.0 = self.0.map_args(|args| args.with_start_after(v));
self
}
/// The recursive is used to control whether the list operation is recursive.
///
/// - If `false`, list operation will only list the entries under the given path.
/// - If `true`, list operation will list all entries that starts with given path.
///
/// Default to `false`.
pub fn recursive(mut self, v: bool) -> Self {
self.0 = self.0.map_args(|args| args.with_recursive(v));
self
}
/// Metakey is used to control which meta should be returned.
///
/// Lister will make sure the result for specified meta is **known**:
///
/// - `Some(v)` means exist.
/// - `None` means services doesn't have this meta.
///
/// The default metakey is `Metakey::Mode`.
pub fn metakey(mut self, v: impl Into<FlagSet<Metakey>>) -> Self {
self.0 = self.0.map_args(|args| args.with_metakey(v));
self
}
/// Call the function to consume all the input and generate a
/// result.
pub fn call(self) -> Result<BlockingLister> {
self.0.call()
}
}
/// Function that generated by [`BlockingOperator::read_with`].
///
/// Users can add more options by public functions provided by this struct.
pub struct FunctionRead(pub(crate) OperatorFunction<(OpRead, BytesRange), Buffer>);
impl FunctionRead {
/// Set the range for this operation.
pub fn range(mut self, range: impl RangeBounds<u64>) -> Self {
self.0 = self.0.map_args(|(args, _)| (args, range.into()));
self
}
/// Call the function to consume all the input and generate a
/// result.
pub fn call(self) -> Result<Buffer> {
self.0.call()
}
}
/// Function that generated by [`BlockingOperator::reader_with`].
///
/// Users can add more options by public functions provided by this struct.
pub struct FunctionReader(pub(crate) OperatorFunction<OpRead, BlockingReader>);
impl FunctionReader {
/// Sets the content-disposition header that should be send back by the remote read operation.
pub fn override_content_disposition(mut self, content_disposition: &str) -> Self {
self.0 = self
.0
.map_args(|args| args.with_override_content_disposition(content_disposition));
self
}
/// Sets the cache-control header that should be send back by the remote read operation.
pub fn override_cache_control(mut self, cache_control: &str) -> Self {
self.0 = self
.0
.map_args(|args| args.with_override_cache_control(cache_control));
self
}
/// Sets the content-type header that should be send back by the remote read operation.
pub fn override_content_type(mut self, content_type: &str) -> Self {
self.0 = self
.0
.map_args(|args| args.with_override_content_type(content_type));
self
}
/// Set the If-Match for this operation.
pub fn if_match(mut self, v: &str) -> Self {
self.0 = self.0.map_args(|args| args.with_if_match(v));
self
}
/// Set the If-None-Match for this operation.
pub fn if_none_match(mut self, v: &str) -> Self {
self.0 = self.0.map_args(|args| args.with_if_none_match(v));
self
}
/// Set the version for this operation.
pub fn version(mut self, v: &str) -> Self {
self.0 = self.0.map_args(|args| args.with_version(v));
self
}
/// Call the function to consume all the input and generate a
/// result.
pub fn call(self) -> Result<BlockingReader> {
self.0.call()
}
}
/// Function that generated by [`BlockingOperator::stat_with`].
///
/// Users can add more options by public functions provided by this struct.
pub struct FunctionStat(pub(crate) OperatorFunction<OpStat, Metadata>);
impl FunctionStat {
/// Set the If-Match for this operation.
pub fn if_match(mut self, v: &str) -> Self {
self.0 = self.0.map_args(|args| args.with_if_match(v));
self
}
/// Set the If-None-Match for this operation.
pub fn if_none_match(mut self, v: &str) -> Self {
self.0 = self.0.map_args(|args| args.with_if_none_match(v));
self
}
/// Set the version for this operation.
pub fn version(mut self, v: &str) -> Self {
self.0 = self.0.map_args(|args| args.with_version(v));
self
}
/// Call the function to consume all the input and generate a
/// result.
pub fn call(self) -> Result<Metadata> {
self.0.call()
}
}