Skip to main content

Fs

POSIX file system support.

Capabilities​

This service can be used to:

  • stat
  • read
  • write
  • append
  • create_dir
  • delete
  • copy
  • rename
  • list
  • scan
  • presign
  • blocking

Configuration​

  • root: Set the work dir for backend.

You can refer to [FsBuilder]'s docs for more information

Example​

Via Builder​

use std::sync::Arc;

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");

    // `Accessor` provides the low level APIs, we will use `Operator` normally.
    let op: Operator = Operator::new(builder)?.finish();

    Ok(())
}

Via Config​

use anyhow::Result;
use opendal::Operator;
use opendal::Scheme;
use std::collections::HashMap;

#[tokio::main]
async fn main() -> Result<()> {
  let mut map = HashMap::new();
  map.insert("root".to_string(), "/path/to/dir".to_string());

  let op: Operator = Operator::via_map(Scheme::Fs, map)?;
  Ok(())
}