You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@opendal.apache.org by xu...@apache.org on 2024/11/26 13:35:37 UTC
(opendal) branch main updated: docs(core): add the description of version parameter for operator (#5144)
This is an automated email from the ASF dual-hosted git repository.
xuanwo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/opendal.git
The following commit(s) were added to refs/heads/main by this push:
new 5834e2817 docs(core): add the description of version parameter for operator (#5144)
5834e2817 is described below
commit 5834e2817861c288f659abd89f71ee4350667523
Author: meteorgan <me...@gmail.com>
AuthorDate: Tue Nov 26 21:35:31 2024 +0800
docs(core): add the description of version parameter for operator (#5144)
---
core/src/types/operator/operator.rs | 106 ++++++++++++++++++++++++++++++++++++
1 file changed, 106 insertions(+)
diff --git a/core/src/types/operator/operator.rs b/core/src/types/operator/operator.rs
index 0e8af0298..83a7877e7 100644
--- a/core/src/types/operator/operator.rs
+++ b/core/src/types/operator/operator.rs
@@ -245,6 +245,24 @@ impl Operator {
/// # }
/// ```
///
+ /// ## `version`
+ ///
+ /// Set `version` for this `stat` request.
+ ///
+ /// This feature can be used to retrieve the metadata of a specific version of the given path
+ ///
+ /// If the version doesn't exist, an error with kind [`ErrorKind::NotFound`] will be returned.
+ ///
+ /// ```no_run
+ /// # use opendal::Result;
+ /// # use opendal::Operator;
+ ///
+ /// # async fn test(op: Operator, version: &str) -> Result<()> {
+ /// let mut metadata = op.stat_with("path/to/file").version(version).await?;
+ /// # Ok(())
+ /// # }
+ /// ```
+ ///
/// # Examples
///
/// ## Get metadata while `ETag` matches
@@ -547,6 +565,24 @@ impl Operator {
/// # }
/// ```
///
+ /// ## `version`
+ ///
+ /// Set `version` for this `read` request.
+ ///
+ /// This feature can be used to retrieve the data of a specified version of the given path.
+ ///
+ /// If the version doesn't exist, an error with kind [`ErrorKind::NotFound`] will be returned.
+ ///
+ /// ```no_run
+ /// # use opendal::Result;
+ /// # use opendal::Operator;
+ ///
+ /// # async fn test(op: Operator, version: &str) -> Result<()> {
+ /// let mut bs = op.read_with("path/to/file").version(version).await?;
+ /// # Ok(())
+ /// # }
+ /// ```
+ ///
/// # Examples
///
/// Read the whole path into a bytes.
@@ -666,6 +702,24 @@ impl Operator {
/// # }
/// ```
///
+ /// ## `version`
+ ///
+ /// Set `version` for this `reader`.
+ ///
+ /// This feature can be used to retrieve the data of a specified version of the given path.
+ ///
+ /// If the version doesn't exist, an error with kind [`ErrorKind::NotFound`] will be returned.
+ ///
+ /// ```no_run
+ /// # use opendal::Result;
+ /// # use opendal::Operator;
+ ///
+ /// # async fn test(op: Operator, version: &str) -> Result<()> {
+ /// let mut bs = op.reader_with("path/to/file").version(version).await?;
+ /// # Ok(())
+ /// # }
+ /// ```
+ ///
/// # Examples
///
/// ```no_run
@@ -1481,6 +1535,26 @@ impl Operator {
///
/// - Deleting a file that does not exist won't return errors.
///
+ /// # Options
+ ///
+ /// ## `version`
+ ///
+ /// Set `version` for this `delete` request.
+ ///
+ /// remove a specific version of the given path.
+ ///
+ /// If the version doesn't exist, OpenDAL will not return errors.
+ ///
+ /// ```no_run
+ /// # use opendal::Result;
+ /// # use opendal::Operator;
+ ///
+ /// # async fn test(op: Operator, version: &str) -> Result<()> {
+ /// op.delete_with("path/to/file").version(version).await?;
+ /// # Ok(())
+ /// # }
+ ///```
+ ///
/// # Examples
///
/// ```
@@ -1786,6 +1860,22 @@ impl Operator {
/// # }
/// ```
///
+ /// ## `version`
+ ///
+ /// Specify whether to list files along with all their versions
+ ///
+ /// if `version` is enabled, all file versions will be returned; otherwise,
+ /// only the current files will be returned.
+ ///
+ /// ```no_run
+ /// # use opendal::Result;
+ /// # use opendal::Operator;
+ /// # async fn test(op: Operator) -> Result<()> {
+ /// let mut entries = op.list_with("path/to/dir/").version(true).await?;
+ /// # Ok(())
+ /// # }
+ /// ```
+ ///
/// # Examples
///
/// ## List all entries recursively
@@ -1936,6 +2026,22 @@ impl Operator {
/// # }
/// ```
///
+ /// ## `version`
+ ///
+ /// Specify whether to list files along with all their versions
+ ///
+ /// if `version` is enabled, all file versions will be returned; otherwise,
+ /// only the current files will be returned.
+ ///
+ /// ```no_run
+ /// # use opendal::Result;
+ /// # use opendal::Operator;
+ /// # async fn test(op: Operator) -> Result<()> {
+ /// let mut entries = op.lister_with("path/to/dir/").version(true).await?;
+ /// # Ok(())
+ /// # }
+ /// ```
+ ///
/// # Examples
///
/// ## List all files recursively