Skip to content

docs: clarify S3 builder URL path handling #822

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

Draft
ZeroAdark wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: clarify S3 builder URL path handling #822

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
5 changes: 4 additions & 1 deletion src/aws/builder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -631,12 +631,15 @@ impl AmazonS3Builder {
///
/// Note: Settings derived from the URL will override any others set on this builder
///
/// A path in the URL is not retained as a prefix. Use [`crate::parse_url`] to create
/// an object store and return the path separately.
///
/// # 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