Skip to content

Tracking issue: Refactor services to use the backend.rs and core.rs convention #5702

@erickguan

Description

@erickguan

Problem Statement

OpenDAL implements services with the following convention:

  • backend.rs
    • Builder: Builds a service's config. For example, see S3's builder. Refer to the Configurator too.
    • Backend: References to the core module and implements the fundamental Access trait.
  • core.rs: Contains code that directly interacts with cloud services, databases, and platforms.
  • other code modules

Currently, some services only implement backend.rs (a lack of core.rs), primarily for historical reasons. The recommended approach is to refactor these services so that each has both backend.rs and core.rs. This new convention makes the code base easier to maintain, read, and contribute to, thereby benefiting OpenDAL’s overall development.

Tasks

If you’re interested in tackling one of these services, feel free to comment on this issue and we’ll help get you started!

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions