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 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913
// 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.
use std::fmt::Debug;
use std::future::ready;
use std::sync::Arc;
use futures::Future;
use crate::raw::*;
use crate::*;
/// Underlying trait of all backends for implementers.
///
/// The actual data access of storage service happens in Accessor layer.
/// Every storage supported by OpenDAL must implement [`Access`] but not all
/// methods of [`Access`] will be implemented according to how the storage service is.
///
/// For example, user can not modify the content from one HTTP file server directly.
/// So [`Http`][crate::services::Http] implements and provides only read related actions.
///
/// [`Access`] gives default implementation for all methods which will raise [`ErrorKind::Unsupported`] error.
/// And what action this [`Access`] supports will be pointed out in [`AccessorInfo`].
///
/// # Note
///
/// Visit [`internals`][crate::docs::internals] for more tutorials.
///
/// # Operations
///
/// - Path in args will all be normalized into the same style, services
/// should handle them based on services' requirement.
/// - Path that ends with `/` means it's Dir, otherwise, it's File.
/// - Root dir is `/`
/// - Path will never be empty.
/// - Operations without capability requirement like `metadata`, `create` are
/// basic operations.
/// - All services must implement them.
/// - Use `unimplemented!()` if not implemented or can't implement.
/// - Operations with capability requirement like `presign` are optional operations.
/// - Services can implement them based on services capabilities.
/// - The default implementation should return [`ErrorKind::Unsupported`].
pub trait Access: Send + Sync + Debug + Unpin + 'static {
/// Reader is the associated reader returned in `read` operation.
type Reader: oio::Read;
/// Writer is the associated writer returned in `write` operation.
type Writer: oio::Write;
/// Lister is the associated lister returned in `list` operation.
type Lister: oio::List;
/// BlockingReader is the associated reader returned `blocking_read` operation.
type BlockingReader: oio::BlockingRead;
/// BlockingWriter is the associated writer returned `blocking_write` operation.
type BlockingWriter: oio::BlockingWrite;
/// BlockingLister is the associated lister returned `blocking_list` operation.
type BlockingLister: oio::BlockingList;
/// Invoke the `info` operation to get metadata of accessor.
///
/// # Notes
///
/// This function is required to be implemented.
///
/// By returning AccessorInfo, underlying services can declare
/// some useful information about it self.
///
/// - scheme: declare the scheme of backend.
/// - capabilities: declare the capabilities of current backend.
fn info(&self) -> Arc<AccessorInfo>;
/// Invoke the `create` operation on the specified path
///
/// Require [`Capability::create_dir`]
///
/// # Behavior
///
/// - Input path MUST match with EntryMode, DON'T NEED to check mode.
/// - Create on existing dir SHOULD succeed.
fn create_dir(
&self,
path: &str,
args: OpCreateDir,
) -> impl Future<Output = Result<RpCreateDir>> + MaybeSend {
let (_, _) = (path, args);
ready(Err(Error::new(
ErrorKind::Unsupported,
"operation is not supported",
)))
}
/// Invoke the `stat` operation on the specified path.
///
/// Require [`Capability::stat`]
///
/// # Behavior
///
/// - `stat` empty path means stat backend's root path.
/// - `stat` a path endswith "/" means stating a dir.
/// - `mode` and `content_length` must be set.
fn stat(&self, path: &str, args: OpStat) -> impl Future<Output = Result<RpStat>> + MaybeSend {
let (_, _) = (path, args);
ready(Err(Error::new(
ErrorKind::Unsupported,
"operation is not supported",
)))
}
/// Invoke the `read` operation on the specified path, returns a
/// [`Reader`][crate::Reader] if operate successful.
///
/// Require [`Capability::read`]
///
/// # Behavior
///
/// - Input path MUST be file path, DON'T NEED to check mode.
/// - The returning content length may be smaller than the range specified.
fn read(
&self,
path: &str,
args: OpRead,
) -> impl Future<Output = Result<(RpRead, Self::Reader)>> + MaybeSend {
let (_, _) = (path, args);
ready(Err(Error::new(
ErrorKind::Unsupported,
"operation is not supported",
)))
}
/// Invoke the `write` operation on the specified path, returns a
/// written size if operate successful.
///
/// Require [`Capability::write`]
///
/// # Behavior
///
/// - Input path MUST be file path, DON'T NEED to check mode.
fn write(
&self,
path: &str,
args: OpWrite,
) -> impl Future<Output = Result<(RpWrite, Self::Writer)>> + MaybeSend {
let (_, _) = (path, args);
ready(Err(Error::new(
ErrorKind::Unsupported,
"operation is not supported",
)))
}
/// Invoke the `delete` operation on the specified path.
///
/// Require [`Capability::delete`]
///
/// # Behavior
///
/// - `delete` is an idempotent operation, it's safe to call `Delete` on the same path multiple times.
/// - `delete` SHOULD return `Ok(())` if the path is deleted successfully or not exist.
fn delete(
&self,
path: &str,
args: OpDelete,
) -> impl Future<Output = Result<RpDelete>> + MaybeSend {
let (_, _) = (path, args);
ready(Err(Error::new(
ErrorKind::Unsupported,
"operation is not supported",
)))
}
/// Invoke the `list` operation on the specified path.
///
/// Require [`Capability::list`]
///
/// # Behavior
///
/// - Input path MUST be dir path, DON'T NEED to check mode.
/// - List non-exist dir should return Empty.
fn list(
&self,
path: &str,
args: OpList,
) -> impl Future<Output = Result<(RpList, Self::Lister)>> + MaybeSend {
let (_, _) = (path, args);
ready(Err(Error::new(
ErrorKind::Unsupported,
"operation is not supported",
)))
}
/// Invoke the `copy` operation on the specified `from` path and `to` path.
///
/// Require [Capability::copy]
///
/// # Behaviour
///
/// - `from` and `to` MUST be file path, DON'T NEED to check mode.
/// - Copy on existing file SHOULD succeed.
/// - Copy on existing file SHOULD overwrite and truncate.
fn copy(
&self,
from: &str,
to: &str,
args: OpCopy,
) -> impl Future<Output = Result<RpCopy>> + MaybeSend {
let (_, _, _) = (from, to, args);
ready(Err(Error::new(
ErrorKind::Unsupported,
"operation is not supported",
)))
}
/// Invoke the `rename` operation on the specified `from` path and `to` path.
///
/// Require [Capability::rename]
fn rename(
&self,
from: &str,
to: &str,
args: OpRename,
) -> impl Future<Output = Result<RpRename>> + MaybeSend {
let (_, _, _) = (from, to, args);
ready(Err(Error::new(
ErrorKind::Unsupported,
"operation is not supported",
)))
}
/// Invoke the `presign` operation on the specified path.
///
/// Require [`Capability::presign`]
///
/// # Behavior
///
/// - This API is optional, return [`std::io::ErrorKind::Unsupported`] if not supported.
fn presign(
&self,
path: &str,
args: OpPresign,
) -> impl Future<Output = Result<RpPresign>> + MaybeSend {
let (_, _) = (path, args);
ready(Err(Error::new(
ErrorKind::Unsupported,
"operation is not supported",
)))
}
/// Invoke the `batch` operations.
///
/// Require [`Capability::batch`]
fn batch(&self, args: OpBatch) -> impl Future<Output = Result<RpBatch>> + MaybeSend {
let _ = args;
ready(Err(Error::new(
ErrorKind::Unsupported,
"operation is not supported",
)))
}
/// Invoke the `blocking_create` operation on the specified path.
///
/// This operation is the blocking version of [`Accessor::create_dir`]
///
/// Require [`Capability::create_dir`] and [`Capability::blocking`]
fn blocking_create_dir(&self, path: &str, args: OpCreateDir) -> Result<RpCreateDir> {
let (_, _) = (path, args);
Err(Error::new(
ErrorKind::Unsupported,
"operation is not supported",
))
}
/// Invoke the `blocking_stat` operation on the specified path.
///
/// This operation is the blocking version of [`Accessor::stat`]
///
/// Require [`Capability::stat`] and [`Capability::blocking`]
fn blocking_stat(&self, path: &str, args: OpStat) -> Result<RpStat> {
let (_, _) = (path, args);
Err(Error::new(
ErrorKind::Unsupported,
"operation is not supported",
))
}
/// Invoke the `blocking_read` operation on the specified path.
///
/// This operation is the blocking version of [`Accessor::read`]
///
/// Require [`Capability::read`] and [`Capability::blocking`]
fn blocking_read(&self, path: &str, args: OpRead) -> Result<(RpRead, Self::BlockingReader)> {
let (_, _) = (path, args);
Err(Error::new(
ErrorKind::Unsupported,
"operation is not supported",
))
}
/// Invoke the `blocking_write` operation on the specified path.
///
/// This operation is the blocking version of [`Accessor::write`]
///
/// Require [`Capability::write`] and [`Capability::blocking`]
fn blocking_write(&self, path: &str, args: OpWrite) -> Result<(RpWrite, Self::BlockingWriter)> {
let (_, _) = (path, args);
Err(Error::new(
ErrorKind::Unsupported,
"operation is not supported",
))
}
/// Invoke the `blocking_delete` operation on the specified path.
///
/// This operation is the blocking version of [`Accessor::delete`]
///
/// Require [`Capability::write`] and [`Capability::blocking`]
fn blocking_delete(&self, path: &str, args: OpDelete) -> Result<RpDelete> {
let (_, _) = (path, args);
Err(Error::new(
ErrorKind::Unsupported,
"operation is not supported",
))
}
/// Invoke the `blocking_list` operation on the specified path.
///
/// This operation is the blocking version of [`Accessor::list`]
///
/// Require [`Capability::list`] and [`Capability::blocking`]
///
/// # Behavior
///
/// - List non-exist dir should return Empty.
fn blocking_list(&self, path: &str, args: OpList) -> Result<(RpList, Self::BlockingLister)> {
let (_, _) = (path, args);
Err(Error::new(
ErrorKind::Unsupported,
"operation is not supported",
))
}
/// Invoke the `blocking_copy` operation on the specified `from` path and `to` path.
///
/// This operation is the blocking version of [`Accessor::copy`]
///
/// Require [`Capability::copy`] and [`Capability::blocking`]
fn blocking_copy(&self, from: &str, to: &str, args: OpCopy) -> Result<RpCopy> {
let (_, _, _) = (from, to, args);
Err(Error::new(
ErrorKind::Unsupported,
"operation is not supported",
))
}
/// Invoke the `blocking_rename` operation on the specified `from` path and `to` path.
///
/// This operation is the blocking version of [`Accessor::rename`]
///
/// Require [`Capability::rename`] and [`Capability::blocking`]
fn blocking_rename(&self, from: &str, to: &str, args: OpRename) -> Result<RpRename> {
let (_, _, _) = (from, to, args);
Err(Error::new(
ErrorKind::Unsupported,
"operation is not supported",
))
}
}
/// `AccessDyn` is the dyn version of [`Access`] make it possible to use as
/// `Box<dyn AccessDyn>`.
pub trait AccessDyn: Send + Sync + Debug + Unpin {
/// Dyn version of [`Accessor::info`]
fn info_dyn(&self) -> Arc<AccessorInfo>;
/// Dyn version of [`Accessor::create_dir`]
fn create_dir_dyn<'a>(
&'a self,
path: &'a str,
args: OpCreateDir,
) -> BoxedFuture<'a, Result<RpCreateDir>>;
/// Dyn version of [`Accessor::stat`]
fn stat_dyn<'a>(&'a self, path: &'a str, args: OpStat) -> BoxedFuture<'a, Result<RpStat>>;
/// Dyn version of [`Accessor::read`]
fn read_dyn<'a>(
&'a self,
path: &'a str,
args: OpRead,
) -> BoxedFuture<'a, Result<(RpRead, oio::Reader)>>;
/// Dyn version of [`Accessor::write`]
fn write_dyn<'a>(
&'a self,
path: &'a str,
args: OpWrite,
) -> BoxedFuture<'a, Result<(RpWrite, oio::Writer)>>;
/// Dyn version of [`Accessor::delete`]
fn delete_dyn<'a>(&'a self, path: &'a str, args: OpDelete)
-> BoxedFuture<'a, Result<RpDelete>>;
/// Dyn version of [`Accessor::list`]
fn list_dyn<'a>(
&'a self,
path: &'a str,
args: OpList,
) -> BoxedFuture<'a, Result<(RpList, oio::Lister)>>;
/// Dyn version of [`Accessor::copy`]
fn copy_dyn<'a>(
&'a self,
from: &'a str,
to: &'a str,
args: OpCopy,
) -> BoxedFuture<'a, Result<RpCopy>>;
/// Dyn version of [`Accessor::rename`]
fn rename_dyn<'a>(
&'a self,
from: &'a str,
to: &'a str,
args: OpRename,
) -> BoxedFuture<'a, Result<RpRename>>;
/// Dyn version of [`Accessor::presign`]
fn presign_dyn<'a>(
&'a self,
path: &'a str,
args: OpPresign,
) -> BoxedFuture<'a, Result<RpPresign>>;
/// Dyn version of [`Accessor::batch`]
fn batch_dyn(&self, args: OpBatch) -> BoxedFuture<'_, Result<RpBatch>>;
/// Dyn version of [`Accessor::blocking_create_dir`]
fn blocking_create_dir_dyn(&self, path: &str, args: OpCreateDir) -> Result<RpCreateDir>;
/// Dyn version of [`Accessor::blocking_stat`]
fn blocking_stat_dyn(&self, path: &str, args: OpStat) -> Result<RpStat>;
/// Dyn version of [`Accessor::blocking_read`]
fn blocking_read_dyn(&self, path: &str, args: OpRead) -> Result<(RpRead, oio::BlockingReader)>;
/// Dyn version of [`Accessor::blocking_write`]
fn blocking_write_dyn(
&self,
path: &str,
args: OpWrite,
) -> Result<(RpWrite, oio::BlockingWriter)>;
/// Dyn version of [`Accessor::blocking_delete`]
fn blocking_delete_dyn(&self, path: &str, args: OpDelete) -> Result<RpDelete>;
/// Dyn version of [`Accessor::blocking_list`]
fn blocking_list_dyn(&self, path: &str, args: OpList) -> Result<(RpList, oio::BlockingLister)>;
/// Dyn version of [`Accessor::blocking_copy`]
fn blocking_copy_dyn(&self, from: &str, to: &str, args: OpCopy) -> Result<RpCopy>;
/// Dyn version of [`Accessor::blocking_rename`]
fn blocking_rename_dyn(&self, from: &str, to: &str, args: OpRename) -> Result<RpRename>;
}
impl<A: ?Sized> AccessDyn for A
where
A: Access<
Reader = oio::Reader,
BlockingReader = oio::BlockingReader,
Writer = oio::Writer,
BlockingWriter = oio::BlockingWriter,
Lister = oio::Lister,
BlockingLister = oio::BlockingLister,
>,
{
fn info_dyn(&self) -> Arc<AccessorInfo> {
self.info()
}
fn create_dir_dyn<'a>(
&'a self,
path: &'a str,
args: OpCreateDir,
) -> BoxedFuture<'a, Result<RpCreateDir>> {
Box::pin(self.create_dir(path, args))
}
fn stat_dyn<'a>(&'a self, path: &'a str, args: OpStat) -> BoxedFuture<'a, Result<RpStat>> {
Box::pin(self.stat(path, args))
}
fn read_dyn<'a>(
&'a self,
path: &'a str,
args: OpRead,
) -> BoxedFuture<'a, Result<(RpRead, oio::Reader)>> {
Box::pin(self.read(path, args))
}
fn write_dyn<'a>(
&'a self,
path: &'a str,
args: OpWrite,
) -> BoxedFuture<'a, Result<(RpWrite, oio::Writer)>> {
Box::pin(self.write(path, args))
}
fn delete_dyn<'a>(
&'a self,
path: &'a str,
args: OpDelete,
) -> BoxedFuture<'a, Result<RpDelete>> {
Box::pin(self.delete(path, args))
}
fn list_dyn<'a>(
&'a self,
path: &'a str,
args: OpList,
) -> BoxedFuture<'a, Result<(RpList, oio::Lister)>> {
Box::pin(self.list(path, args))
}
fn copy_dyn<'a>(
&'a self,
from: &'a str,
to: &'a str,
args: OpCopy,
) -> BoxedFuture<'a, Result<RpCopy>> {
Box::pin(self.copy(from, to, args))
}
fn rename_dyn<'a>(
&'a self,
from: &'a str,
to: &'a str,
args: OpRename,
) -> BoxedFuture<'a, Result<RpRename>> {
Box::pin(self.rename(from, to, args))
}
fn presign_dyn<'a>(
&'a self,
path: &'a str,
args: OpPresign,
) -> BoxedFuture<'a, Result<RpPresign>> {
Box::pin(self.presign(path, args))
}
fn batch_dyn(&self, args: OpBatch) -> BoxedFuture<'_, Result<RpBatch>> {
Box::pin(self.batch(args))
}
fn blocking_create_dir_dyn(&self, path: &str, args: OpCreateDir) -> Result<RpCreateDir> {
self.blocking_create_dir(path, args)
}
fn blocking_stat_dyn(&self, path: &str, args: OpStat) -> Result<RpStat> {
self.blocking_stat(path, args)
}
fn blocking_read_dyn(&self, path: &str, args: OpRead) -> Result<(RpRead, oio::BlockingReader)> {
self.blocking_read(path, args)
}
fn blocking_write_dyn(
&self,
path: &str,
args: OpWrite,
) -> Result<(RpWrite, oio::BlockingWriter)> {
self.blocking_write(path, args)
}
fn blocking_delete_dyn(&self, path: &str, args: OpDelete) -> Result<RpDelete> {
self.blocking_delete(path, args)
}
fn blocking_list_dyn(&self, path: &str, args: OpList) -> Result<(RpList, oio::BlockingLister)> {
self.blocking_list(path, args)
}
fn blocking_copy_dyn(&self, from: &str, to: &str, args: OpCopy) -> Result<RpCopy> {
self.blocking_copy(from, to, args)
}
fn blocking_rename_dyn(&self, from: &str, to: &str, args: OpRename) -> Result<RpRename> {
self.blocking_rename(from, to, args)
}
}
impl Access for dyn AccessDyn {
type Reader = oio::Reader;
type BlockingReader = oio::BlockingReader;
type Writer = oio::Writer;
type BlockingWriter = oio::BlockingWriter;
type Lister = oio::Lister;
type BlockingLister = oio::BlockingLister;
fn info(&self) -> Arc<AccessorInfo> {
self.info_dyn()
}
async fn create_dir(&self, path: &str, args: OpCreateDir) -> Result<RpCreateDir> {
self.create_dir_dyn(path, args).await
}
async fn stat(&self, path: &str, args: OpStat) -> Result<RpStat> {
self.stat_dyn(path, args).await
}
async fn read(&self, path: &str, args: OpRead) -> Result<(RpRead, Self::Reader)> {
self.read_dyn(path, args).await
}
async fn write(&self, path: &str, args: OpWrite) -> Result<(RpWrite, Self::Writer)> {
self.write_dyn(path, args).await
}
async fn delete(&self, path: &str, args: OpDelete) -> Result<RpDelete> {
self.delete_dyn(path, args).await
}
async fn list(&self, path: &str, args: OpList) -> Result<(RpList, Self::Lister)> {
self.list_dyn(path, args).await
}
async fn copy(&self, from: &str, to: &str, args: OpCopy) -> Result<RpCopy> {
self.copy_dyn(from, to, args).await
}
async fn rename(&self, from: &str, to: &str, args: OpRename) -> Result<RpRename> {
self.rename_dyn(from, to, args).await
}
async fn presign(&self, path: &str, args: OpPresign) -> Result<RpPresign> {
self.presign_dyn(path, args).await
}
fn batch(&self, args: OpBatch) -> impl Future<Output = Result<RpBatch>> + MaybeSend {
self.batch_dyn(args)
}
fn blocking_create_dir(&self, path: &str, args: OpCreateDir) -> Result<RpCreateDir> {
self.blocking_create_dir_dyn(path, args)
}
fn blocking_read(&self, path: &str, args: OpRead) -> Result<(RpRead, Self::BlockingReader)> {
self.blocking_read_dyn(path, args)
}
fn blocking_stat(&self, path: &str, args: OpStat) -> Result<RpStat> {
self.blocking_stat_dyn(path, args)
}
fn blocking_write(&self, path: &str, args: OpWrite) -> Result<(RpWrite, Self::BlockingWriter)> {
self.blocking_write_dyn(path, args)
}
fn blocking_delete(&self, path: &str, args: OpDelete) -> Result<RpDelete> {
self.blocking_delete_dyn(path, args)
}
fn blocking_list(&self, path: &str, args: OpList) -> Result<(RpList, Self::BlockingLister)> {
self.blocking_list_dyn(path, args)
}
fn blocking_copy(&self, from: &str, to: &str, args: OpCopy) -> Result<RpCopy> {
self.blocking_copy_dyn(from, to, args)
}
fn blocking_rename(&self, from: &str, to: &str, args: OpRename) -> Result<RpRename> {
self.blocking_rename_dyn(from, to, args)
}
}
/// Dummy implementation of accessor.
impl Access for () {
type Reader = ();
type Writer = ();
type Lister = ();
type BlockingReader = ();
type BlockingWriter = ();
type BlockingLister = ();
fn info(&self) -> Arc<AccessorInfo> {
AccessorInfo {
scheme: Scheme::Custom("dummy"),
root: "".to_string(),
name: "dummy".to_string(),
native_capability: Capability::default(),
full_capability: Capability::default(),
}
.into()
}
}
/// All functions in `Accessor` only requires `&self`, so it's safe to implement
/// `Accessor` for `Arc<impl Access>`.
// If we use async fn directly, some weird higher rank trait bound error (`Send`/`Accessor` impl not general enough) will happen.
// Probably related to https://github.com/rust-lang/rust/issues/96865
#[allow(clippy::manual_async_fn)]
impl<T: Access + ?Sized> Access for Arc<T> {
type Reader = T::Reader;
type Writer = T::Writer;
type Lister = T::Lister;
type BlockingReader = T::BlockingReader;
type BlockingWriter = T::BlockingWriter;
type BlockingLister = T::BlockingLister;
fn info(&self) -> Arc<AccessorInfo> {
self.as_ref().info()
}
fn create_dir(
&self,
path: &str,
args: OpCreateDir,
) -> impl Future<Output = Result<RpCreateDir>> + MaybeSend {
async move { self.as_ref().create_dir(path, args).await }
}
fn stat(&self, path: &str, args: OpStat) -> impl Future<Output = Result<RpStat>> + MaybeSend {
async move { self.as_ref().stat(path, args).await }
}
fn read(
&self,
path: &str,
args: OpRead,
) -> impl Future<Output = Result<(RpRead, Self::Reader)>> + MaybeSend {
async move { self.as_ref().read(path, args).await }
}
fn write(
&self,
path: &str,
args: OpWrite,
) -> impl Future<Output = Result<(RpWrite, Self::Writer)>> + MaybeSend {
async move { self.as_ref().write(path, args).await }
}
fn delete(
&self,
path: &str,
args: OpDelete,
) -> impl Future<Output = Result<RpDelete>> + MaybeSend {
async move { self.as_ref().delete(path, args).await }
}
fn list(
&self,
path: &str,
args: OpList,
) -> impl Future<Output = Result<(RpList, Self::Lister)>> + MaybeSend {
async move { self.as_ref().list(path, args).await }
}
fn copy(
&self,
from: &str,
to: &str,
args: OpCopy,
) -> impl Future<Output = Result<RpCopy>> + MaybeSend {
async move { self.as_ref().copy(from, to, args).await }
}
fn rename(
&self,
from: &str,
to: &str,
args: OpRename,
) -> impl Future<Output = Result<RpRename>> + MaybeSend {
async move { self.as_ref().rename(from, to, args).await }
}
fn presign(
&self,
path: &str,
args: OpPresign,
) -> impl Future<Output = Result<RpPresign>> + MaybeSend {
async move { self.as_ref().presign(path, args).await }
}
fn batch(&self, args: OpBatch) -> impl Future<Output = Result<RpBatch>> + MaybeSend {
async move { self.as_ref().batch(args).await }
}
fn blocking_create_dir(&self, path: &str, args: OpCreateDir) -> Result<RpCreateDir> {
self.as_ref().blocking_create_dir(path, args)
}
fn blocking_stat(&self, path: &str, args: OpStat) -> Result<RpStat> {
self.as_ref().blocking_stat(path, args)
}
fn blocking_read(&self, path: &str, args: OpRead) -> Result<(RpRead, Self::BlockingReader)> {
self.as_ref().blocking_read(path, args)
}
fn blocking_write(&self, path: &str, args: OpWrite) -> Result<(RpWrite, Self::BlockingWriter)> {
self.as_ref().blocking_write(path, args)
}
fn blocking_delete(&self, path: &str, args: OpDelete) -> Result<RpDelete> {
self.as_ref().blocking_delete(path, args)
}
fn blocking_list(&self, path: &str, args: OpList) -> Result<(RpList, Self::BlockingLister)> {
self.as_ref().blocking_list(path, args)
}
fn blocking_copy(&self, from: &str, to: &str, args: OpCopy) -> Result<RpCopy> {
self.as_ref().blocking_copy(from, to, args)
}
fn blocking_rename(&self, from: &str, to: &str, args: OpRename) -> Result<RpRename> {
self.as_ref().blocking_rename(from, to, args)
}
}
/// Accessor is the type erased accessor with `Arc<dyn Accessor>`.
pub type Accessor = Arc<dyn AccessDyn>;
/// Metadata for accessor, users can use this metadata to get information of underlying backend.
#[derive(Clone, Debug, Default)]
pub struct AccessorInfo {
scheme: Scheme,
root: String,
name: String,
native_capability: Capability,
full_capability: Capability,
}
impl AccessorInfo {
/// [`Scheme`] of backend.
pub fn scheme(&self) -> Scheme {
self.scheme
}
/// Set [`Scheme`] for backend.
pub fn set_scheme(&mut self, scheme: Scheme) -> &mut Self {
self.scheme = scheme;
self
}
/// Root of backend, will be in format like `/path/to/dir/`
pub fn root(&self) -> &str {
&self.root
}
/// Set root for backend.
///
/// Note: input root must be normalized.
pub fn set_root(&mut self, root: &str) -> &mut Self {
self.root = root.to_string();
self
}
/// Name of backend, could be empty if underlying backend doesn't have namespace concept.
///
/// For example:
///
/// - name for `s3` => bucket name
/// - name for `azblob` => container name
pub fn name(&self) -> &str {
&self.name
}
/// Set name of this backend.
pub fn set_name(&mut self, name: &str) -> &mut Self {
self.name = name.to_string();
self
}
/// Get backend's native capabilities.
pub fn native_capability(&self) -> Capability {
self.native_capability
}
/// Set native capabilities for service.
///
/// # NOTES
///
/// Set native capability will also flush the full capability. The only way to change
/// full_capability is via `full_capability_mut`.
pub fn set_native_capability(&mut self, capability: Capability) -> &mut Self {
self.native_capability = capability;
self.full_capability = capability;
self
}
/// Get service's full capabilities.
pub fn full_capability(&self) -> Capability {
self.full_capability
}
/// Get service's full capabilities.
pub fn full_capability_mut(&mut self) -> &mut Capability {
&mut self.full_capability
}
}