Skip to content

Document S3 with_url path handling #725

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.

Sign up for GitHub

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

Closed
Herrtian wants to merge 1 commit into from
Closed

Document S3 with_url path handling #725

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions src/aws/builder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -598,7 +598,7 @@ impl AmazonS3Builder {
builder
}

/// Parse available connection info form a well-known storage URL.
/// Parse available connection info from a well-known storage URL.
///
/// The supported url schemes are:
///
Expand All @@ -608,14 +608,18 @@ impl AmazonS3Builder {
/// - `https://<bucket>.s3.<region>.amazonaws.com`
/// - `https://ACCOUNT_ID.r2.cloudflarestorage.com/bucket`
///
/// Note: Settings derived from the URL will override any others set on this builder
/// Note: Settings derived from the URL will override any others set on this builder.
///
/// The path component is not retained by the returned [`AmazonS3`] store. Use
/// [`parse_url`](crate::parse_url) or [`ObjectStoreRegistry`](crate::registry::ObjectStoreRegistry)
/// when the path or prefix should be preserved alongside the store.
///
/// # Example
/// ```
/// use object_store::aws::AmazonS3Builder;
///
/// let s3 = AmazonS3Builder::from_env()
/// .with_url("s3://bucket/path")
/// .with_url("s3://bucket")
/// .build();
/// ```
pub fn with_url(mut self, url: impl Into<String>) -> Self {
Expand Down
Loading