Code Monkey home page Code Monkey logo

s3-tokio's Introduction

build MIT licensed

s3-tokio docs

Rust library for working with Amazon S3 or arbitrary S3 compatible APIs, fully compatible with async/await and futures ^0.3.

Only tokio and rustls support.

Note

This repository is a fork of rust-s3-async(what is fork of rust-s3) but with only tokio and rustls support. Also with updated dependencies. (for example hyper ^1)

Intro

Modest interface towards Amazon S3, as well as S3 compatible object storage APIs such as Backblaze B2, Wasabi, Yandex, Minio, Cloudflare R2 or Google Cloud Storage. Supports: put, get, list, delete, operations on tags and location, as well as head.

Additionally, a dedicated presign_get Bucket method is available. This means you can upload to S3, and give the link to select people without having to worry about publicly accessible files on S3. This also means that you can give people a PUT presigned URL, meaning they can upload to a specific key in S3 for the duration of the presigned URL.

Quick Start

Read and run examples from the examples folder, make sure you have valid credentials for the variant you're running.

# tokio, default
cargo run --example tokio

# minio
# First, start Minio on port 9000.
AWS_ACCESS_KEY_ID="minioadmin" \
AWS_SECRET_ACCESS_KEY="minioadmin" \
    cargo run --example minio

# r2
cargo run --example r2

# google cloud
cargo run --example google-cloud

Features

There are a lot of various features that enable a wide variety of use cases, refer to s3/Cargo.toml for an exhaustive list. Below is a table of various useful features as well as a short description for each.

  • default - only fail-on-err
  • fail-on-err - panic on any error
  • no-verify-ssl - disable SSL verification for endpoints, useful for custom regions

Path or subdomain style URLs and headers

Bucket struct provides constructors for path-style paths, subdomain style is the default. Bucket exposes methods for configuring and accessing path-style configuration.

Buckets

create async
delete async
list async
exists async

Presign

POST presign_put
PUT presign_put
GET presign_get
DELETE presign_delete

GET

There are a few different options for getting an object and methods are generic over tokio::io::AsyncWriteExt.

async/sync/async-blocking get_object
async/sync/async-blocking get_object_stream
async/sync/async-blocking get_object_to_writer

PUT

Each GET method has a PUT companion, and tokio methods are generic over tokio::io::AsyncReadExt.

async/sync/async-blocking put_object
async/sync/async-blocking put_object_with_content_type
async/sync/async-blocking put_object_stream

List

async/sync/async-blocking list

DELETE

async/sync/async-blocking delete_object

Location

async/sync/async-blocking location

Tagging

async/sync/async-blocking put_object_tagging
async/sync/async-blocking get_object_tagging

Head

async/sync/async-blocking head_object

Usage (in Cargo.toml)

[dependencies]
s3-tokio = "0.39"

s3-tokio's People

Contributors

durch avatar femlolstudio avatar aalekhpatel07 avatar jgoday avatar nastevens avatar dependabot[bot] avatar ten0 avatar golddranks avatar tomkarw avatar cholcombe973 avatar cdncentreforchildprotection avatar guilload avatar janrupf avatar jplatte avatar shonenada avatar kenkoooo avatar sseemayer avatar bellwether-softworks avatar mentormate-doug avatar sonicdes avatar bmeu avatar mvines avatar mdashti avatar npv3s avatar posborne avatar psmit avatar robinfriedli avatar savente93 avatar ns-sjorgedeaguiar avatar zifeo avatar

Stargazers

Nghia avatar Christoph Grabo avatar

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.