Skip to main content

S3Config

s3_wire

Struct S3Config 

Source 
pub struct S3Config { /* private fields */ }
Expand description

Validated configuration used to construct an S3 client.

Implementations§

Source§

impl S3Config

Source

pub fn builder() -> S3ConfigBuilder

Starts a configuration builder with HTTPS-safe defaults.

Source

pub fn endpoint(&self) -> &Endpoint

Returns the service endpoint.

Source

pub fn region(&self) -> &str

Returns the signing region.

Source

pub fn bucket(&self) -> &str

Returns the configured bucket.

Source

pub fn addressing_style(&self) -> AddressingStyle

Returns the configured bucket addressing style.

Source

pub fn connect_timeout(&self) -> Duration

Returns the connection-establishment timeout.

Source

pub fn attempt_timeout(&self) -> Duration

Returns the timeout applied to a single request attempt.

Source

pub fn operation_timeout(&self) -> Duration

Returns the overall operation timeout across all attempts.

Source

pub fn idle_body_timeout(&self) -> Duration

Returns the maximum permitted gap between response body chunks.

Source

pub fn max_xml_response_size(&self) -> usize

Returns the maximum XML response body size in bytes.

Source

pub fn max_error_response_size(&self) -> usize

Returns the maximum error response body size in bytes.

Source

pub fn retry_policy(&self) -> &RetryPolicy

Returns the retry policy.

Source

pub fn user_agent(&self) -> &str

Returns the HTTP user-agent value.

Source

pub fn credentials_provider(&self) -> &Arc<dyn CredentialsProvider> ⓘ

Returns the credential provider.

Source

pub fn observer(&self) -> Option<&Arc<dyn RequestObserver>>

Returns the optional sanitized request observer.

Source

pub fn for_bucket(&self, bucket: impl Into<String>) -> Result<Self, S3Error>

Clones this service configuration for another bucket.

This is used by crate::S3Client::for_bucket to retain the same connection pool and credential provider while validating the new bucket for the configured addressing style.

§Errors

Returns an error when the bucket is empty or invalid for the configured endpoint and addressing style.

Trait Implementations§

Source§

impl Clone for S3Config

Source§

fn clone(&self) -> S3Config

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for S3Config

Source§

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more