Skip to content

Commit

Permalink
Added docs.
Browse files Browse the repository at this point in the history
Signed-off-by: Pavel Kirilin <[email protected]>
  • Loading branch information
s3rius committed Dec 24, 2022
1 parent 3bcc7dc commit 16017ef
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 7 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ You can install rustus by 4 different ways.

### From source

To build it from source rust must be installed.
Preferred version is 1.59.0.
To build it from source rust must be installed. We don't rely on nightly features,
you can use last stable release.

```bash
git clone https://github.com/s3rius/rustus.git
Expand Down
2 changes: 1 addition & 1 deletion deploy/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM rust:1.64.0-bullseye AS builder
FROM rust:1.66.0-bullseye AS builder

WORKDIR /app
COPY Cargo.toml Cargo.lock ./
Expand Down
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@ You can install rustus in four different ways.

### From source

To build it from source rust must be installed.
Preferred version is 1.59.0.
To build it from source rust must be installed. We don't rely on nightly features,
you can use last stable release.

```bash
git clone https://github.com/s3rius/rustus.git
cd rustus
cargo install --path . --features=all,metrics
cargo install --path . --features=all
```

Also, you can speedup build by disabling some features.
Expand Down
3 changes: 2 additions & 1 deletion src/storages/s3_hybrid_storage.rs
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,8 @@ impl S3HybridStorage {

/// Upload file to S3.
///
/// This function is called with
/// This function is called to upload file to s3 completely.
/// It streams file directly from disk to s3.
async fn upload_file(&self, file_info: &FileInfo) -> RustusResult<()> {
if file_info.path.is_none() {
return Err(RustusError::UnableToWrite("Cannot get upload path.".into()));
Expand Down

0 comments on commit 16017ef

Please sign in to comment.