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 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
// Copyright 2022 Datafuse Labs
//
// Licensed 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::ops::RangeBounds;
use bytes::Bytes;
use flagset::FlagSet;
use futures::stream;
use futures::AsyncReadExt;
use futures::Stream;
use futures::StreamExt;
use futures::TryStreamExt;
use time::Duration;
use tokio::io::ReadBuf;
use super::BlockingOperator;
use crate::ops::*;
use crate::raw::*;
use crate::*;
/// Operator is the entry for all public async APIs.
///
/// Read [`concepts`][docs::concepts] for know more about [`Operator`].
///
/// # Examples
///
/// Read more backend init examples in [`services`]
///
/// ```
/// # use anyhow::Result;
/// use opendal::services::Fs;
/// use opendal::Operator;
/// #[tokio::main]
/// async fn main() -> Result<()> {
/// // Create fs backend builder.
/// let mut builder = Fs::default();
/// // Set the root for fs, all operations will happen under this root.
/// //
/// // NOTE: the root must be absolute path.
/// builder.root("/tmp");
///
/// // Build an `Operator` to start operating the storage.
/// let _: Operator = Operator::new(builder)?.finish();
///
/// Ok(())
/// }
/// ```
#[derive(Clone, Debug)]
pub struct Operator {
accessor: FusedAccessor,
limit: usize,
}
/// # Operator basic API.
impl Operator {
pub(super) fn inner(&self) -> &FusedAccessor {
&self.accessor
}
pub(crate) fn from_inner(accessor: FusedAccessor) -> Self {
Self {
accessor,
limit: 1000,
}
}
pub(super) fn into_inner(self) -> FusedAccessor {
self.accessor
}
/// Get current operator's limit
pub fn limit(&self) -> usize {
self.limit
}
/// Specify the batch limit.
///
/// Default: 1000
pub fn with_limit(&self, limit: usize) -> Self {
let mut op = self.clone();
op.limit = limit;
op
}
/// Get information of underlying accessor.
///
/// # Examples
///
/// ```
/// # use std::sync::Arc;
/// # use anyhow::Result;
/// use opendal::Operator;
///
/// # #[tokio::main]
/// # async fn test(op: Operator) -> Result<()> {
/// let info = op.info();
/// # Ok(())
/// # }
/// ```
pub fn info(&self) -> OperatorInfo {
OperatorInfo::new(self.accessor.info())
}
/// Create a new blocking operator.
///
/// This operation is nearly no cost.
pub fn blocking(&self) -> BlockingOperator {
BlockingOperator::from_inner(self.accessor.clone()).with_limit(self.limit)
}
}
/// Operator async API.
impl Operator {
/// Check if this operator can work correctly.
///
/// We will send a `list` request to path and return any errors we met.
///
/// ```
/// # use std::sync::Arc;
/// # use anyhow::Result;
/// use opendal::Operator;
///
/// # #[tokio::main]
/// # async fn test(op: Operator) -> Result<()> {
/// op.check().await?;
/// # Ok(())
/// # }
/// ```
pub async fn check(&self) -> Result<()> {
let mut ds = self.list("/").await?;
match ds.next().await {
Some(Err(e)) if e.kind() != ErrorKind::NotFound => Err(e),
_ => Ok(()),
}
}
/// Get current path's metadata **without cache** directly.
///
/// # Notes
///
/// Use `stat` if you:
///
/// - Want detect the outside changes of path.
/// - Don't want to read from cached metadata.
///
/// You may want to use `metadata` if you are working with entries
/// returned by [`Lister`]. It's highly possible that metadata
/// you want has already been cached.
///
/// # Examples
///
/// ```
/// # use anyhow::Result;
/// # use futures::io;
/// # use opendal::Operator;
/// use opendal::ErrorKind;
/// #
/// # #[tokio::main]
/// # async fn test(op: Operator) -> Result<()> {
/// if let Err(e) = op.stat("test").await {
/// if e.kind() == ErrorKind::NotFound {
/// println!("file not exist")
/// }
/// }
/// # Ok(())
/// # }
/// ```
pub async fn stat(&self, path: &str) -> Result<Metadata> {
let path = normalize_path(path);
let rp = self.inner().stat(&path, OpStat::new()).await?;
let meta = rp.into_metadata();
Ok(meta)
}
/// Get current metadata with cache.
///
/// `metadata` will check the given query with already cached metadata
/// first. And query from storage if not found.
///
/// # Notes
///
/// Use `metadata` if you are working with entries returned by
/// [`Lister`]. It's highly possible that metadata you want
/// has already been cached.
///
/// You may want to use `stat`, if you:
///
/// - Want detect the outside changes of path.
/// - Don't want to read from cached metadata.
///
/// # Behavior
///
/// Visiting not fetched metadata will lead to panic in debug build.
/// It must be a bug, please fix it instead.
///
/// # Examples
///
/// ## Query already cached metadata
///
/// By query metadata with `None`, we can only query in-memory metadata
/// cache. In this way, we can make sure that no API call will send.
///
/// ```
/// # use anyhow::Result;
/// # use opendal::Operator;
/// use opendal::Entry;
/// # #[tokio::main]
/// # async fn test(op: Operator, entry: Entry) -> Result<()> {
/// let meta = op.metadata(&entry, None).await?;
/// // content length COULD be correct.
/// let _ = meta.content_length();
/// // etag COULD be correct.
/// let _ = meta.etag();
/// # Ok(())
/// # }
/// ```
///
/// ## Query content length and content type
///
/// ```
/// # use anyhow::Result;
/// # use opendal::Operator;
/// use opendal::Entry;
/// use opendal::Metakey;
///
/// # #[tokio::main]
/// # async fn test(op: Operator, entry: Entry) -> Result<()> {
/// let meta = op
/// .metadata(&entry, Metakey::ContentLength | Metakey::ContentType)
/// .await?;
/// // content length MUST be correct.
/// let _ = meta.content_length();
/// // etag COULD be correct.
/// let _ = meta.etag();
/// # Ok(())
/// # }
/// ```
///
/// ## Query all metadata
///
/// By query metadata with `Complete`, we can make sure that we have fetched all metadata of this entry.
///
/// ```
/// # use anyhow::Result;
/// # use opendal::Operator;
/// use opendal::Entry;
/// use opendal::Metakey;
///
/// # #[tokio::main]
/// # async fn test(op: Operator, entry: Entry) -> Result<()> {
/// let meta = op.metadata(&entry, Metakey::Complete).await?;
/// // content length MUST be correct.
/// let _ = meta.content_length();
/// // etag MUST be correct.
/// let _ = meta.etag();
/// # Ok(())
/// # }
/// ```
pub async fn metadata(
&self,
entry: &Entry,
flags: impl Into<FlagSet<Metakey>>,
) -> Result<Metadata> {
// Check if cached metadata saticifies the query.
if let Some(meta) = entry.metadata() {
if meta.bit().contains(flags) || meta.bit().contains(Metakey::Complete) {
return Ok(meta.clone());
}
}
// Else request from backend..
let meta = self.stat(entry.path()).await?;
Ok(meta)
}
/// Check if this path exists or not.
///
/// # Example
///
/// ```
/// use anyhow::Result;
/// use futures::io;
/// use opendal::Operator;
///
/// #[tokio::main]
/// async fn test(op: Operator) -> Result<()> {
/// let _ = op.is_exist("test").await?;
///
/// Ok(())
/// }
/// ```
pub async fn is_exist(&self, path: &str) -> Result<bool> {
let r = self.stat(path).await;
match r {
Ok(_) => Ok(true),
Err(err) => match err.kind() {
ErrorKind::NotFound => Ok(false),
_ => Err(err),
},
}
}
/// Create a dir at given path.
///
/// # Notes
///
/// To indicate that a path is a directory, it is compulsory to include
/// a trailing / in the path. Failure to do so may result in
/// `NotADirectory` error being returned by OpenDAL.
///
/// # Behavior
///
/// - Create on existing dir will succeed.
/// - Create dir is always recursive, works like `mkdir -p`
///
/// # Examples
///
/// ```
/// # use std::io::Result;
/// # use opendal::Operator;
/// # use futures::TryStreamExt;
/// # #[tokio::main]
/// # async fn test(op: Operator) -> Result<()> {
/// op.create_dir("path/to/dir/").await?;
/// # Ok(())
/// # }
/// ```
pub async fn create_dir(&self, path: &str) -> Result<()> {
let path = normalize_path(path);
if !validate_path(&path, EntryMode::DIR) {
return Err(
Error::new(ErrorKind::NotADirectory, "read path is not a directory")
.with_operation("create_dir")
.with_context("service", self.inner().info().scheme())
.with_context("path", &path),
);
}
self.inner()
.create(&path, OpCreate::new(EntryMode::DIR))
.await?;
Ok(())
}
/// Read the whole path into a bytes.
///
/// This function will allocate a new bytes internally. For more precise memory control or
/// reading data lazily, please use [`Operator::reader`]
///
/// # Examples
///
/// ```
/// # use std::io::Result;
/// # use opendal::Operator;
/// # use futures::TryStreamExt;
/// # #[tokio::main]
/// # async fn test(op: Operator) -> Result<()> {
/// let bs = op.read("path/to/file").await?;
/// # Ok(())
/// # }
/// ```
pub async fn read(&self, path: &str) -> Result<Vec<u8>> {
self.range_read(path, ..).await
}
/// Read the specified range of path into a bytes.
///
/// This function will allocate a new bytes internally. For more precise memory control or
/// reading data lazily, please use [`Operator::range_reader`]
///
/// # Notes
///
/// - The returning content's length may be smaller than the range specified.
///
/// # Examples
///
/// ```
/// # use std::io::Result;
/// # use opendal::Operator;
/// # use futures::TryStreamExt;
/// # #[tokio::main]
/// # async fn test(op: Operator) -> Result<()> {
/// let bs = op.range_read("path/to/file", 1024..2048).await?;
/// # Ok(())
/// # }
/// ```
pub async fn range_read(&self, path: &str, range: impl RangeBounds<u64>) -> Result<Vec<u8>> {
let path = normalize_path(path);
if !validate_path(&path, EntryMode::FILE) {
return Err(
Error::new(ErrorKind::IsADirectory, "read path is a directory")
.with_operation("range_read")
.with_context("service", self.inner().info().scheme())
.with_context("path", &path),
);
}
let br = BytesRange::from(range);
let op = OpRead::new().with_range(br);
let (rp, mut s) = self.inner().read(&path, op).await?;
let length = rp.into_metadata().content_length() as usize;
let mut buffer = Vec::with_capacity(length);
let dst = buffer.spare_capacity_mut();
let mut buf = ReadBuf::uninit(dst);
// Safety: the input buffer is created with_capacity(length).
unsafe { buf.assume_init(length) };
// TODO: use native read api
s.read_exact(buf.initialized_mut()).await.map_err(|err| {
Error::new(ErrorKind::Unexpected, "read from storage")
.with_operation("range_read")
.with_context("service", self.inner().info().scheme().into_static())
.with_context("path", &path)
.with_context("range", br.to_string())
.set_source(err)
})?;
// Safety: read_exact makes sure this buffer has been filled.
unsafe { buffer.set_len(length) }
Ok(buffer)
}
/// Create a new reader which can read the whole path.
///
/// # Examples
///
/// ```no_run
/// # use std::io::Result;
/// # use opendal::Operator;
/// # use futures::TryStreamExt;
/// # use opendal::Scheme;
/// # #[tokio::main]
/// # async fn test(op: Operator) -> Result<()> {
/// let r = op.reader("path/to/file").await?;
/// # Ok(())
/// # }
/// ```
pub async fn reader(&self, path: &str) -> Result<Reader> {
self.range_reader(path, ..).await
}
/// Create a new reader which can read the specified range.
///
/// # Notes
///
/// - The returning content's length may be smaller than the range specified.
///
/// # Examples
///
/// ```no_run
/// # use std::io::Result;
/// # use opendal::Operator;
/// # use futures::TryStreamExt;
/// # #[tokio::main]
/// # async fn test(op: Operator) -> Result<()> {
/// let r = op.range_reader("path/to/file", 1024..2048).await?;
/// # Ok(())
/// # }
/// ```
pub async fn range_reader(&self, path: &str, range: impl RangeBounds<u64>) -> Result<Reader> {
let path = normalize_path(path);
if !validate_path(&path, EntryMode::FILE) {
return Err(
Error::new(ErrorKind::IsADirectory, "read path is a directory")
.with_operation("Operator::range_reader")
.with_context("service", self.info().scheme())
.with_context("path", path),
);
}
let op = OpRead::new().with_range(range.into());
Reader::create(self.inner().clone(), &path, op).await
}
/// Write bytes into path.
///
/// # Notes
///
/// - Write will make sure all bytes has been written, or an error will be returned.
///
/// # Examples
///
/// ```
/// # use std::io::Result;
/// # use opendal::Operator;
/// # use futures::StreamExt;
/// # use futures::SinkExt;
/// use bytes::Bytes;
///
/// # #[tokio::main]
/// # async fn test(op: Operator) -> Result<()> {
/// op.write("path/to/file", vec![0; 4096]).await?;
/// # Ok(())
/// # }
/// ```
pub async fn write(&self, path: &str, bs: impl Into<Bytes>) -> Result<()> {
self.write_with(path, OpWrite::new(), bs).await
}
/// Write multiple bytes into path.
///
/// # Notes
///
/// - Write will make sure all bytes has been written, or an error will be returned.
///
/// # Examples
///
/// ```
/// # use std::io::Result;
/// # use opendal::Operator;
/// # use futures::StreamExt;
/// # use futures::SinkExt;
/// use bytes::Bytes;
///
/// # #[tokio::main]
/// # async fn test(op: Operator) -> Result<()> {
/// let mut w = op.writer("path/to/file").await?;
/// w.append(vec![0; 4096]).await?;
/// w.append(vec![1; 4096]).await?;
/// w.close().await?;
/// # Ok(())
/// # }
/// ```
pub async fn writer(&self, path: &str) -> Result<Writer> {
let path = normalize_path(path);
if !validate_path(&path, EntryMode::FILE) {
return Err(
Error::new(ErrorKind::IsADirectory, "write path is a directory")
.with_operation("Operator::writer")
.with_context("service", self.inner().info().scheme().into_static())
.with_context("path", &path),
);
}
let op = OpWrite::default().with_append();
Writer::create(self.inner().clone(), &path, op).await
}
/// Write data with extra options.
///
/// # Notes
///
/// - Write will make sure all bytes has been written, or an error will be returned.
///
/// # Examples
///
/// ```no_run
/// # use std::io::Result;
/// # use opendal::Operator;
/// use bytes::Bytes;
/// use opendal::ops::OpWrite;
///
/// # #[tokio::main]
/// # async fn test(op: Operator) -> Result<()> {
/// let bs = b"hello, world!".to_vec();
/// let args = OpWrite::new().with_content_type("text/plain");
/// let _ = op.write_with("path/to/file", args, bs).await?;
/// # Ok(())
/// # }
/// ```
pub async fn write_with(&self, path: &str, args: OpWrite, bs: impl Into<Bytes>) -> Result<()> {
let path = normalize_path(path);
if !validate_path(&path, EntryMode::FILE) {
return Err(
Error::new(ErrorKind::IsADirectory, "write path is a directory")
.with_operation("Operator::write_with")
.with_context("service", self.info().scheme().into_static())
.with_context("path", &path),
);
}
let (_, mut w) = self.inner().write(&path, args).await?;
w.write(bs.into()).await?;
w.close().await?;
Ok(())
}
/// Delete the given path.
///
/// # Notes
///
/// - Delete not existing error won't return errors.
///
/// # Examples
///
/// ```
/// # use anyhow::Result;
/// # use futures::io;
/// # use opendal::Operator;
/// # #[tokio::main]
/// # async fn test(op: Operator) -> Result<()> {
/// op.delete("test").await?;
/// # Ok(())
/// # }
/// ```
pub async fn delete(&self, path: &str) -> Result<()> {
let path = normalize_path(path);
let _ = self.inner().delete(&path, OpDelete::new()).await?;
Ok(())
}
///
/// # Notes
///
/// If underlying services support delete in batch, we will use batch
/// delete instead.
///
/// # Examples
///
/// ```
/// # use anyhow::Result;
/// # use futures::io;
/// # use opendal::Operator;
/// #
/// # #[tokio::main]
/// # async fn test(op: Operator) -> Result<()> {
/// op.remove(vec!["abc".to_string(), "def".to_string()])
/// .await?;
/// # Ok(())
/// # }
/// ```
pub async fn remove(&self, paths: Vec<String>) -> Result<()> {
self.remove_via(stream::iter(paths)).await
}
/// remove will given paths.
/// remove_via will remove files via given stream.
///
/// We will delete by chunks with given batch limit on the stream.
///
/// # Notes
///
/// If underlying services support delete in batch, we will use batch
/// delete instead.
///
/// # Examples
///
/// ```
/// # use anyhow::Result;
/// # use futures::io;
/// # use opendal::Operator;
/// use futures::stream;
/// #
/// # #[tokio::main]
/// # async fn test(op: Operator) -> Result<()> {
/// let stream = stream::iter(vec!["abc".to_string(), "def".to_string()]);
/// op.remove_via(stream).await?;
/// # Ok(())
/// # }
/// ```
pub async fn remove_via(&self, input: impl Stream<Item = String> + Unpin) -> Result<()> {
if self.info().can_batch() {
let mut input = input.map(|v| (v, OpDelete::default())).chunks(self.limit());
while let Some(batches) = input.next().await {
let results = self
.inner()
.batch(OpBatch::new(BatchOperations::Delete(batches)))
.await?;
let BatchedResults::Delete(results) = results.into_results();
// TODO: return error here directly seems not a good idea?
for (_, result) in results {
let _ = result?;
}
}
} else {
input
.map(Ok)
.try_for_each_concurrent(self.limit, |path| async move {
let _ = self.inner().delete(&path, OpDelete::default()).await?;
Ok::<(), Error>(())
})
.await?;
}
Ok(())
}
/// Remove the path and all nested dirs and files recursively.
///
/// # Notes
///
/// If underlying services support delete in batch, we will use batch
/// delete instead.
///
/// # Examples
///
/// ```
/// # use anyhow::Result;
/// # use futures::io;
/// # use opendal::Operator;
/// #
/// # #[tokio::main]
/// # async fn test(op: Operator) -> Result<()> {
/// op.remove_all("path/to/dir").await?;
/// # Ok(())
/// # }
/// ```
pub async fn remove_all(&self, path: &str) -> Result<()> {
let meta = self.stat(path).await?;
if meta.mode() != EntryMode::DIR {
return self.delete(path).await;
}
let obs = self.scan(path).await?;
if self.info().can_batch() {
let mut obs = obs.try_chunks(self.limit());
while let Some(batches) = obs.next().await {
let batches = batches
.map_err(|err| err.1)?
.into_iter()
.map(|v| (v.path().to_string(), OpDelete::default()))
.collect();
let results = self
.inner()
.batch(OpBatch::new(BatchOperations::Delete(batches)))
.await?;
let BatchedResults::Delete(results) = results.into_results();
// TODO: return error here directly seems not a good idea?
for (_, result) in results {
let _ = result?;
}
}
} else {
obs.try_for_each(|v| async move { self.delete(v.path()).await })
.await?;
}
Ok(())
}
/// List given path.
///
/// This function will create a new handle to list entries.
///
/// An error will be returned if given path doesn't end with `/`.
///
/// # Examples
///
/// ```no_run
/// # use anyhow::Result;
/// # use futures::io;
/// # use opendal::Operator;
/// # use opendal::EntryMode;
/// # use futures::TryStreamExt;
/// use opendal::Metakey;
/// # #[tokio::main]
/// # async fn test(op: Operator) -> Result<()> {
/// let mut ds = op.list("path/to/dir/").await?;
/// while let Some(mut de) = ds.try_next().await? {
/// let meta = op.metadata(&de, Metakey::Mode).await?;
/// match meta.mode() {
/// EntryMode::FILE => {
/// println!("Handling file")
/// }
/// EntryMode::DIR => {
/// println!("Handling dir like start a new list via meta.path()")
/// }
/// EntryMode::Unknown => continue,
/// }
/// }
/// # Ok(())
/// # }
/// ```
pub async fn list(&self, path: &str) -> Result<Lister> {
let path = normalize_path(path);
if !validate_path(&path, EntryMode::DIR) {
return Err(Error::new(
ErrorKind::NotADirectory,
"the path trying to list is not a directory",
)
.with_operation("Operator::list")
.with_context("service", self.info().scheme().into_static())
.with_context("path", &path));
}
let (_, pager) = self.inner().list(&path, OpList::new()).await?;
Ok(Lister::new(pager))
}
/// List dir in flat way.
///
/// This function will create a new handle to list entries.
///
/// An error will be returned if given path doesn't end with `/`.
///
/// # Examples
///
/// ```no_run
/// # use anyhow::Result;
/// # use futures::io;
/// # use opendal::Operator;
/// # use opendal::EntryMode;
/// # use futures::TryStreamExt;
/// use opendal::Metakey;
/// #
/// # #[tokio::main]
/// # async fn test(op: Operator) -> Result<()> {
/// let mut ds = op.scan("/path/to/dir/").await?;
/// while let Some(mut de) = ds.try_next().await? {
/// let meta = op.metadata(&de, Metakey::Mode).await?;
/// match meta.mode() {
/// EntryMode::FILE => {
/// println!("Handling file")
/// }
/// EntryMode::DIR => {
/// println!("Handling dir like start a new list via meta.path()")
/// }
/// EntryMode::Unknown => continue,
/// }
/// }
/// # Ok(())
/// # }
/// ```
pub async fn scan(&self, path: &str) -> Result<Lister> {
let path = normalize_path(path);
if !validate_path(&path, EntryMode::DIR) {
return Err(Error::new(
ErrorKind::NotADirectory,
"the path trying to list is not a directory",
)
.with_operation("scan")
.with_context("service", self.info().scheme().into_static())
.with_context("path", &path));
}
let (_, pager) = self.inner().scan(&path, OpScan::new()).await?;
Ok(Lister::new(pager))
}
}
/// Operator presign API.
impl Operator {
/// Presign an operation for stat(head).
///
/// # Example
///
/// ```no_run
/// use anyhow::Result;
/// use futures::io;
/// use opendal::Operator;
/// use time::Duration;
///
/// #[tokio::main]
/// async fn test(op: Operator) -> Result<()> {
/// let signed_req = op.presign_stat("test",Duration::hours(1))?;
/// let req = http::Request::builder()
/// .method(signed_req.method())
/// .uri(signed_req.uri())
/// .body(())?;
///
/// # Ok(())
/// # }
/// ```
pub fn presign_stat(&self, path: &str, expire: Duration) -> Result<PresignedRequest> {
let path = normalize_path(path);
let op = OpPresign::new(OpStat::new(), expire);
let rp = self.inner().presign(&path, op)?;
Ok(rp.into_presigned_request())
}
/// Presign an operation for read.
///
/// # Example
///
/// ```no_run
/// use anyhow::Result;
/// use futures::io;
/// use opendal::Operator;
/// use time::Duration;
///
/// #[tokio::main]
/// async fn test(op: Operator) -> Result<()> {
/// let signed_req = op.presign_read("test.txt", Duration::hours(1))?;
/// # Ok(())
/// # }
/// ```
///
/// - `signed_req.method()`: `GET`
/// - `signed_req.uri()`: `https://s3.amazonaws.com/examplebucket/test.txt?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=access_key_id/20130721/us-east-1/s3/aws4_request&X-Amz-Date=20130721T201207Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=<signature-value>`
/// - `signed_req.headers()`: `{ "host": "s3.amazonaws.com" }`
///
/// We can download this file via `curl` or other tools without credentials:
///
/// ```shell
/// curl "https://s3.amazonaws.com/examplebucket/test.txt?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=access_key_id/20130721/us-east-1/s3/aws4_request&X-Amz-Date=20130721T201207Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=<signature-value>" -O /tmp/test.txt
/// ```
pub fn presign_read(&self, path: &str, expire: Duration) -> Result<PresignedRequest> {
let path = normalize_path(path);
let op = OpPresign::new(OpRead::new(), expire);
let rp = self.inner().presign(&path, op)?;
Ok(rp.into_presigned_request())
}
/// Presign an operation for write.
///
/// # Example
///
/// ```no_run
/// use anyhow::Result;
/// use futures::io;
/// use opendal::Operator;
/// use time::Duration;
///
/// #[tokio::main]
/// async fn test(op: Operator) -> Result<()> {
/// let signed_req = op.presign_write("test.txt", Duration::hours(1))?;
/// # Ok(())
/// # }
/// ```
///
/// - `signed_req.method()`: `PUT`
/// - `signed_req.uri()`: `https://s3.amazonaws.com/examplebucket/test.txt?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=access_key_id/20130721/us-east-1/s3/aws4_request&X-Amz-Date=20130721T201207Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=<signature-value>`
/// - `signed_req.headers()`: `{ "host": "s3.amazonaws.com" }`
///
/// We can upload file as this file via `curl` or other tools without credential:
///
/// ```shell
/// curl -X PUT "https://s3.amazonaws.com/examplebucket/test.txt?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=access_key_id/20130721/us-east-1/s3/aws4_request&X-Amz-Date=20130721T201207Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=<signature-value>" -d "Hello, World!"
/// ```
pub fn presign_write(&self, path: &str, expire: Duration) -> Result<PresignedRequest> {
self.presign_write_with(path, OpWrite::new(), expire)
}
/// Presign an operation for write with option described in OpenDAL [rfc-0661](../../docs/rfcs/0661-path-in-accessor.md)
///
/// You can pass `OpWrite` to this method to specify the content length and content type.
///
/// # Example
///
/// ```no_run
/// use anyhow::Result;
/// use futures::io;
/// use opendal::ops::OpWrite;
/// use opendal::Operator;
/// use time::Duration;
///
/// #[tokio::main]
/// async fn test(op: Operator) -> Result<()> {
/// let args = OpWrite::new().with_content_type("text/csv");
/// let signed_req = op.presign_write_with("test", args, Duration::hours(1))?;
/// let req = http::Request::builder()
/// .method(signed_req.method())
/// .uri(signed_req.uri())
/// .body(())?;
///
/// # Ok(())
/// # }
/// ```
pub fn presign_write_with(
&self,
path: &str,
op: OpWrite,
expire: Duration,
) -> Result<PresignedRequest> {
let path = normalize_path(path);
let op = OpPresign::new(op, expire);
let rp = self.inner().presign(&path, op)?;
Ok(rp.into_presigned_request())
}
}