Method read_for_edit

core/src/workspace/mod.rs:713–732

Read a file for a subsequent modify-write cycle, requesting a version token when the backend supports compare-and-swap writes. Returns `(content, Some(version))` when [`Self::fs_ext`] is available (e.g. on S3, where the version is the object ETag); `(content, None)` otherwise. Pair with [`Self::write_for_edit`].

(
        &self,
        path: &WorkspacePath,
    )

    /// (e.g. on S3, where the version is the object ETag); `(content, None)`
    /// otherwise. Pair with [`Self::write_for_edit`].
    pub async fn read_for_edit(
        &self,
        path: &WorkspacePath,
    ) -> WorkspaceResult<(String, Option<String>)> {
        if let Some(ext) = self.fs_ext() {
            let path = path.clone();
            return self
                .run_with_timeout("read_text_with_version", async move {
                    let (content, version) = ext.read_text_with_version(&path).await?;
                    Ok((content, Some(version)))
                })
                .await;
        }
        let fs = self.fs();
        let path_owned = path.clone();
        let content = self
            .run_with_timeout("read_text", async move { fs.read_text(&path_owned).await })
            .await?;
        Ok((content, None))
    }

    /// Companion to [`Self::read_for_edit`]. Performs a compare-and-swap
    /// write when both [`Self::fs_ext`] is available *and* a version token