Struct opendal::services::Fs

pub struct Fs { /* private fields */ }

POSIX file system support.

Capabilities

This service can be used to:

• read
• write
• list
• scan
• presign
• blocking

Configuration

• root: Set the work dir for backend.

Refer to FsBuilder’s public API 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(())
}

Implementations

impl FsBuilder

pub fn root(&mut self, root: &str) -> &mut Self

Set root for backend.

pub fn atomic_write_dir(&mut self, dir: &str) -> &mut Self

Set temp dir for atomic write.

pub fn enable_path_check(&mut self) -> &mut Self

OpenDAL requires all input path are normalized to make sure the behavior is consistent. By enable path check, we can make sure fs will behave the same as other services.

Enabling this feature will lead to extra metadata call in all operations.

Trait Implementations

impl Builder for FsBuilder

const SCHEME: Scheme = Scheme::Fs

Associated scheme for this builder.

type Accessor = FsBackend

The accessor that built by this builder.

fn from_map(map: HashMap<String, String>) -> Self

Construct a builder from given map.

fn build(&mut self) -> Result<Self::Accessor>

Consume the accessor builder to build a service.

fn from_iter(iter: impl Iterator<Item = (String, String)>) -> Selfwhere
    Self: Sized,

Construct a builder from given iterator.

fn from_env() -> Selfwhere
    Self: Sized,

Construct a builder from envs.

impl Debug for FsBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FsBuilder

fn default() -> FsBuilder

Returns the “default value” for a type.