Struct Fs

pub struct Fs {
    config: FsConfig,
}

POSIX file system support.

Capabilities

This service can be used to:

• stat
• read
• write
• append
• create_dir
• delete
• copy
• rename
• list
• 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.
        .root("/tmp");

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

    Ok(())
}

Fields

config: FsConfig

Implementations

impl FsBuilder

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

Set root for backend.

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

Set temp dir for atomic write.

Notes

• When append is enabled, we will not use atomic write to avoid data loss and performance issue.

Trait Implementations

impl Builder for FsBuilder

const SCHEME: Scheme = Scheme::Fs

Associated scheme for this builder. It indicates what underlying service is.

type Config = FsConfig

Associated configuration for this builder.

fn build(self) -> Result<impl Access, Error>

Consume the accessor builder to build a service.

impl Debug for FsBuilder

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

Formats the value using the given formatter.

impl Default for FsBuilder

fn default() -> FsBuilder

Returns the “default value” for a type.