Skip to main content

Crate opendal_service_fs

Crate opendal_service_fs 

Source
Expand description

§Apache OpenDAL™ Filesystem Service

opendal-service-fs provides access to the local filesystem for applications built with Apache OpenDAL™.

§Use through opendal

Applications should normally enable this service through the opendal facade with the services-fs feature:

cargo add opendal --features services-fs

The service is available as opendal::services::Fs. Configure the service builder, then pass it to opendal::Operator::new.

§Use with opendal-core

Add the split crates directly:

cargo add opendal-core opendal-service-fs

Pass a configured service builder to Operator::new:

use opendal_core::{Operator, OperatorRegistry, Result};
use opendal_service_fs::{register_fs_service, Fs};

fn build_operator(builder: Fs) -> Result<Operator> {
    Operator::new(builder)
}

fn register_for_uri() {
    register_fs_service(OperatorRegistry::get());
}

register_for_uri is only needed for scheme-driven construction through Operator::from_uri or Operator::via_iter.

Services that send HTTP requests also require an HTTP transport in OperationContext. See the opendal-core composition example.

§Documentation

§License

Licensed under the Apache License, Version 2.0.

Structs§

Fs
POSIX file system support.
FsConfig
config for file system

Constants§

FILE_SCHEME
Alias scheme for fs service that follows the standard URI scheme.
FS_SCHEME
URI scheme used for service registration and scheme-driven construction.

Functions§

register_fs_service
Register this service’s URI scheme or schemes with an operator registry.