Struct Gridfs 

pub struct Gridfs { /* private fields */ }

Capabilities

This service can be used to:

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

Configuration

• root: Set the working directory of OpenDAL
• connection_string: Set the connection string of mongodb server
• database: Set the database of mongodb
• bucket: Set the bucket of mongodb gridfs
• chunk_size: Set the chunk size of mongodb gridfs

Example

Via Builder

use anyhow::Result;
use opendal::services::Gridfs;
use opendal::Operator;

#[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)?.finish();
    Ok(())
}

Implementations

impl GridfsBuilder

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

Available on crate feature services-gridfs only.

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) -> Self

Available on crate feature services-gridfs only.

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

default: “/”

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

Available on crate feature services-gridfs only.

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

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

Available on crate feature services-gridfs only.

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) -> Self

Available on crate feature services-gridfs only.

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

Available on crate feature services-gridfs only.

type Config = GridfsConfig

Associated configuration for this builder.

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

Consume the accessor builder to build a service.

impl Default for GridfsBuilder

Available on crate feature services-gridfs only.

fn default() -> GridfsBuilder

Returns the “default value” for a type.