Skip to main content

StorageOptionsAccessor

Struct StorageOptionsAccessor 

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

Unified access to storage options with automatic caching and refresh

This struct bundles static storage options with an optional dynamic provider, handling all caching and refresh logic internally. It provides a single entry point for accessing storage options regardless of whether they’re static or dynamic.

§Behavior

  • If only static options are provided, returns those options
  • If a provider is configured, fetches from provider and caches results
  • Automatically refreshes cached options before expiration (based on refresh_offset)
  • Uses expires_at_millis key to track expiration

§Thread Safety

The accessor is thread-safe and can be shared across multiple tasks. Concurrent refresh attempts are deduplicated using a try-lock mechanism.

Implementations§

Source§

impl StorageOptionsAccessor

Source

pub fn with_static_options(options: HashMap<String, String>) -> Self

Create an accessor with only static options (no refresh capability)

The returned accessor will always return the provided options. This is useful when credentials don’t expire or are managed externally.

Source

pub fn with_provider(provider: Arc<dyn StorageOptionsProvider>) -> Self

Create an accessor with a dynamic provider (no initial options)

The accessor will fetch from the provider on first access and cache the results. Refresh happens automatically before expiration. Uses the default refresh offset (60 seconds) until options are fetched.

§Arguments
  • provider - The storage options provider for fetching fresh options
Source

pub fn with_initial_and_provider( initial_options: HashMap<String, String>, provider: Arc<dyn StorageOptionsProvider>, ) -> Self

Create an accessor with initial options and a dynamic provider

Initial options are used until they expire, then the provider is called. This avoids an immediate fetch when initial credentials are still valid. The refresh_offset_millis key in initial_options controls refresh timing.

§Arguments
  • initial_options - Initial storage options to cache
  • provider - The storage options provider for refreshing
Source

pub async fn get_storage_options(&self) -> Result<StorageOptions>

Get current valid storage options

  • Returns cached options if not expired
  • Fetches from provider if expired or not cached
  • Falls back to initial_options if provider returns None
§Errors

Returns an error if:

  • The provider fails to fetch options
  • No options are available (no cache, no provider, no initial options)
Source

pub fn initial_storage_options(&self) -> Option<&HashMap<String, String>>

Get the initial storage options without refresh

Returns the initial options that were provided when creating the accessor. This does not trigger any refresh, even if the options have expired.

Source

pub fn accessor_id(&self) -> String

Get the accessor ID for equality/hashing

Returns the provider_id if a provider exists, otherwise generates a stable ID from the initial options hash.

Source

pub fn has_provider(&self) -> bool

Check if this accessor has a dynamic provider

Source

pub fn refresh_offset(&self) -> Duration

Get the refresh offset duration

Source

pub fn provider(&self) -> Option<&Arc<dyn StorageOptionsProvider>>

Get the storage options provider, if any

Trait Implementations§

Source§

impl Debug for StorageOptionsAccessor

Source§

fn fmt(&self, f: &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> 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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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
Source§

impl<T> MaybeSend for T
where T: Send,