Git Product home page Git Product logo

remi-rs's Introduction

🐻‍❄️🧶 Remi (Rust Edition)

Robust, and simple asynchronous Rust crate to handle storage-related communications with different storage providers.

v0.7.1 | 📜 Documentation

remi-rs is a Rust port of Noelware's Java-based Remi for the Rust programming language. It provides a easy way to implement storage-related communications with different storage providers like Amazon S3, Google Cloud Storage, Azure Blob Storage, and more.

Noelware has ported the Java-based Remi libraries since we use Kotlin and Rust heavily in our products and services, so it made sense to have both support for Remi in Java and Rust.

Note

As of the v0.5 release, remi-rs will be our main priority. Java version is no longer maintained by the Noelware team.

Warning

These crates are highly experimental and shouldn't be used in production environments yet as they are still v0. While these crates are in our products, it is for testing them and see how they do in our environments.

remi-rs is somewhat experimental, the only Remi crate that is finalized is the local filesystem and Amazon S3, as that is more tested within Noelware's Rust applications.

Supported

Unsupported

  • Oracle Cloud Infrastructure Object Storage: Use the remi-s3 crate instead as it supported a S3-compatible API.
  • Digital Ocean Spaces: You can use the S3 storage service since it has a S3-compatible API
  • Google Cloud Storage: Plan to do it soon when there is an officially maintained Google Cloud SDK that is reliable or a community-maintained version can be present if wished.
  • Alibaba Cloud OSS Storage
  • Tencent Cloud COS Storage
  • OpenStack Object Storage
  • Baidu Cloud BOS Storage
  • Netease Cloud NOS Storage

You can create your own community crate with the remi crate.

Usage

As this library is asynchronously only, you will need to configure an async runtime! Us at Noelware use Tokio, but using async-std is experimental and things might break.

The main crate (remi) since v0.5.0 and above cleans up the code from remi-core and is migrated to that library instead to make more sense out of it, essentially, remi-core has been decommissioned since the v0.5 release.

Examples for each crate can be ran with cargo run --package [crate-name] --example [example-name] and will live in crates/{crate-name}/examples.

License

remi-rs is released under the MIT License with love by Noelware. :3

remi-rs's People

Contributors

auguwu avatar noelbot avatar renovate[bot] avatar spotlightishere avatar

Stargazers

avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar

Watchers

avatar avatar

remi-rs's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

cargo
Cargo.toml
  • bollard 0.17.0
  • testcontainers 0.21.0
crates/azure/Cargo.toml
  • async-trait 0.1.80
  • azure_core 0.20.0
  • azure_storage 0.20.0
  • azure_storage_blobs 0.20.0
  • bytes 1.6.0
  • futures-util 0.3.30
  • log 0.4.21
  • serde 1.0.200
  • tracing 0.1.40
  • tokio 1.37.0
  • tracing 0.1.40
  • tracing-subscriber 0.3.18
crates/fs/Cargo.toml
  • async-trait 0.1.80
  • bytes 1.6.0
  • dirs 5.0.1
  • file-format 0.25.0
  • infer 0.16.0
  • log 0.4.21
  • serde 1.0.200
  • serde_json 1.0.116
  • serde_yaml 0.9.34
  • tokio 1.37.0
  • tracing 0.1.40
  • tempfile 3.10.1
  • tokio 1.37.0
  • tracing 0.1.40
  • tracing-subscriber 0.3.18
crates/gridfs/Cargo.toml
  • async-trait 0.1.80
  • bytes 1.6.0
  • futures-util 0.3.30
  • log 0.4.21
  • mongodb 3.0.0
  • serde 1.0.200
  • tokio-util 0.7.11
  • tracing 0.1.40
  • tokio 1.37.0
  • tracing 0.1.40
  • tracing-subscriber 0.3.18
crates/s3/Cargo.toml
  • async-trait 0.1.80
  • aws-config 1.3.0
  • aws-credential-types 1.2.0
  • aws-sdk-s3 1.25.0
  • aws-smithy-runtime-api 1.5.0
  • bytes 1.6.0
  • log 0.4.21
  • serde 1.0.200
  • tracing 0.1.40
  • tokio 1.37.0
  • tracing 0.1.40
  • tracing-subscriber 0.3.18
remi/Cargo.toml
  • async-trait 0.1.80
  • bytes 1.6.0
devcontainer
.devcontainer/devcontainer.json
  • ghcr.io/devcontainers/features/sshd 1
github-actions
.github/workflows/Lint.yaml
  • actions/checkout v4
  • Swatinem/rust-cache v2
  • actions/checkout v4
  • Swatinem/rust-cache v2
  • auguwu/clippy-action 1.4.0
  • actions/checkout v4
  • actions/checkout v4
.github/workflows/Release.yaml
  • actions/checkout v4
  • Swatinem/rust-cache v2
  • Check this box to trigger a request for Renovate to run again on this repository

Fix CI for Azure crate

related to do:

remi-rs/crates/azure/src/service.rs

Lines 449 to 452 in 1689362

// in CI (GitHub Actions), it will pull the `azurite` image as a Windows container and Microsoft
// doesn't ship Windows containers of the `azurite` image, so we just ignore the test alltogether
//
// TODO(@auguwu): how to fix this? :3

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Location: renovate.json
Error type: The renovate configuration file contains some invalid settings
Message: Invalid regExp for customManagers[0].fileMatch: **/*.rs

Allow to add metadata to supported services

Allows the use to append metadata to supported services:

  • Amazon S3
  • Azure Blob Storage
  • MongoDB GridFS

related to TODO:

remi-rs/crates/gridfs/src/service.rs

Lines 432 to 438 in 1689362

let mut stream = self.0.open_upload_stream(path_str, None);
stream.write_all(&options.data[..]).await?;
stream.close().await
// TODO(@auguwu): add metadata to document that was created and the given content type
// if one was supplied.
}

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.