Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs(storage-opendal): clarify the IO timeout and serialization docs
Name OpenDAL's `io_timeout` and `timeout` settings so it is clear the property
bounds each IO call per retry attempt and leaves control operations such as
`stat` at 60 seconds. Align the `OpenDalStorage` serialization note with the
wording on `FileIO::serialize_all`.

Co-authored-by: Copilot App <[email protected]>
  • Loading branch information
kevinjqliu and Copilot committed Oct 4, 2026
commit 38af8ab4228e18d5c8a8dcd1170d1cab278818dc
9 changes: 6 additions & 3 deletions crates/storage/opendal/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,11 @@ cfg_if! {
mod resolving;
pub use resolving::{OpenDalResolvingStorage, OpenDalResolvingStorageFactory};

/// Per-attempt timeout in milliseconds for OpenDAL IO operations (read, write, list, delete).
/// Defaults to 10 seconds. Control operations such as `stat` keep OpenDAL's 60-second timeout.
/// Timeout in milliseconds for each IO call on a reader, writer, lister or deleter, applied per
/// retry attempt via OpenDAL's `TimeoutLayer::with_io_timeout`. Defaults to 10 seconds.
///
/// OpenDAL's separate `timeout`, which bounds whole control operations such as `stat`, is not
/// affected and stays at its 60-second default.
pub const OPENDAL_IO_TIMEOUT_MS: &str = "opendal.io-timeout-ms";

/// Matches OpenDAL's `TimeoutLayer` default.
Expand Down Expand Up @@ -273,7 +276,7 @@ fn default_memory_operator() -> Operator {

/// OpenDAL-based storage implementation.
///
/// The serialized form is not stable across crate versions.
/// The serialized representation is not a stable format and may change between crate versions.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub enum OpenDalStorage {
/// Memory storage variant.
Expand Down