Struct Gridfs 

pub struct Gridfs { /* private fields */ }

Available on crate feature services-gridfs only.

Capabilities

Depending on its configuration and the backing system, this service can expose:

• create_dir
• stat
• read
• write
• delete
• list
• copy
• rename
• presign

Inspect the effective capability set with opendal_core::Operator::info and opendal_core::OperatorInfo::capability after building an operator.

Configuration

Use crate::GridfsConfig for serializable configuration and this builder’s methods for direct construction. The field and method documentation defines accepted values, defaults, and environment interaction.

Example

Via Builder

use opendal_core::Operator;
use opendal_core::Result;
use opendal_service_gridfs::Gridfs;

#[tokio::main]
async fn main() -> Result<()> {
    let mut builder = Gridfs::default()
        .root("/")
        .connection_string("mongodb://myUser:myPassword@localhost:27017/myAuthDB")
        .database("your_database")
        .bucket("your_bucket")
        // The chunk size in bytes used to break the user file into chunks.
        .chunk_size(255);

    let op = Operator::new(builder)?;
    Ok(())
}

Implementations

impl GridfsBuilder

pub fn connection_string(self, v: &str) -> GridfsBuilder

Set the connection_string of the MongoDB service.

This connection string is used to connect to the MongoDB service. It typically follows the format:

Format

mongodb://[username:password@]host1[:port1][,...hostN[:portN]][/[defaultauthdb][?options]]

Examples:

• Connecting to a local MongoDB instance: mongodb://localhost:27017
• Using authentication: mongodb://myUser:myPassword@localhost:27017/myAuthDB
• Specifying authentication mechanism: mongodb://myUser:myPassword@localhost:27017/myAuthDB?authMechanism=SCRAM-SHA-256

Options

• authMechanism: Specifies the authentication method to use. Examples include SCRAM-SHA-1, SCRAM-SHA-256, and MONGODB-AWS.
• … (any other options you wish to highlight)

For more information, please refer to MongoDB Connection String URI Format.

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

Set the working directory, all operations will be performed under it.

default: “/”

pub fn database(self, database: &str) -> GridfsBuilder

Set the database name of the MongoDB GridFs service to read/write.

pub fn bucket(self, bucket: &str) -> GridfsBuilder

Set the bucket name of the MongoDB GridFs service to read/write.

Default to fs if not specified.

pub fn chunk_size(self, chunk_size: u32) -> GridfsBuilder

Set the chunk size of the MongoDB GridFs service used to break the user file into chunks.

Default to 255 KiB if not specified.

Trait Implementations

impl Builder for GridfsBuilder

type Config = GridfsConfig

Associated configuration.

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

Consume the builder to build a service.

impl Debug for GridfsBuilder

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

Formats the value using the given formatter.

impl Default for GridfsBuilder

fn default() -> GridfsBuilder

Returns the “default value” for a type.