Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature Request]: Abstract file provider interface #505

Open
3 tasks done
BilliAlpha opened this issue Sep 14, 2024 · 0 comments
Open
3 tasks done

[Feature Request]: Abstract file provider interface #505

BilliAlpha opened this issue Sep 14, 2024 · 0 comments
Labels
Type: Enhancement New feature or request Type: File System File system interactions

Comments

@BilliAlpha
Copy link

BilliAlpha commented Sep 14, 2024

Checklist

  • I am using an up-to-date version.
  • I have read the documentation.
  • I have searched existing issues.

Description

As described here : #197 (comment)

It would be interesting to provide abstraction and create a generic file provider interface (with a default implementation per OS filesystem) so that we could later add support for other file systems (be it on the network, encrypted or really anything).
It would allow support for S3, FTP, SSHFS, GPG encrypted files etc ...

Solution

Define a generic interface to be implemented by all file providers that provides all required methods.
It could potentially aid with implementation of #295, a library could reference a list of file providers instead of directly referencing a folder.

Each provider should be able to return a list of files where each file has one or more identifiers (a path, some hashes, creation timestamp, or other custom IDs). These identifiers would link it to an entry.
Then providers should also implement reading (and potentially writing) methods that could be required to render a preview/thumbnail and to view/edit metadata.

Alternatives

No response

@BilliAlpha BilliAlpha added the Type: Enhancement New feature or request label Sep 14, 2024
@CyanVoxel CyanVoxel added the Type: File System File system interactions label Sep 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Enhancement New feature or request Type: File System File system interactions
Projects
None yet
Development

No branches or pull requests

2 participants