Struct UnityObjectStoreFactory 

pub struct UnityObjectStoreFactory { /* private fields */ }

Factory that mints object_store instances backed by Unity Catalog credential vending.

Implementations

impl UnityObjectStoreFactory

pub fn builder() -> UnityObjectStoreFactoryBuilder

pub fn with_forwarded_user( &self, header: &str, user: Option<&str>, ) -> Result<Self>

Derive a factory that forwards a trusted reverse-proxy identity header on every upstream Unity Catalog request (both the metadata lookups and the credential vend).

Intended for a service — e.g. the standalone storage byte-proxy — that sits behind the same reverse proxy as the upstream UC and has already validated the caller’s identity. Forwarding the header verbatim lets UC’s own reverse-proxy authenticator attribute the vend to the real end user.

Semantics:

• user == None (anonymous request) → returns self cloned unchanged, so the upstream calls use whatever auth the base factory was built with (its static token, or unauthenticated). Zero added cost.
• user == Some(name) → returns a factory whose upstream transport is unauthenticated and injects header: name on every request. The base factory’s static token is intentionally dropped for these calls: the forwarded identity is the auth, not the proxy’s own principal.

header is the outgoing header name (typically the same x-forwarded-user the proxy read the identity from). Returns an error if header or name is not a valid HTTP header name / value.

Native-only: on wasm32 identity is forwarded by the browser session, so this method is absent.

pub fn unity_client(&self) -> &UnityCatalogClient

Borrow the underlying UnityCatalogClient for catalog metadata operations (listing volumes, resolving table names, …).

pub fn credentials_client(&self) -> &TemporaryCredentialClient

Borrow the underlying credential-vending client. Most users want for_url / for_volume / for_table / for_path instead.

pub async fn for_url(&self, url: &str, op: Operation) -> Result<UCStore>

Build an UCStore for any supported URL.

See UCReference for the supported URL grammar. Raw cloud URLs (s3://, gs://, abfss://, …) are routed to for_path.

pub async fn for_table( &self, table: impl Into<TableReference>, operation: TableOperation, ) -> Result<UCStore>

Vend credentials for a table and return a prefixed store rooted at the table’s storage location.

The table argument accepts a Uuid, a String / &str containing a three-level <catalog>.<schema>.<table> name, or any TableReference.

pub async fn for_volume( &self, volume: impl Into<VolumeReference>, operation: VolumeOperation, ) -> Result<UCStore>

Vend credentials for a volume and return a prefixed store rooted at the volume’s storage location.

A volume whose storage location is a file:// path is served by a local LocalFileSystem store and never hits the credential-vending API — local storage has no cloud credential to vend.

pub async fn for_path( &self, path: &Url, operation: PathOperation, ) -> Result<UCStore>

Vend credentials for a raw cloud URL (s3://, gs://, abfss://, …). Uses temporary-path-credentials under the hood.

file:// URLs are served by a local LocalFileSystem store and never hit the credential-vending API — local storage has no cloud credential to vend.

pub async fn dry_run_path( &self, path: &Url, operation: PathOperation, ) -> Result<UCStore>

Vend credentials for a raw cloud URL with dry_run set to true. The server validates that credentials could be issued but the returned token is not usable for IO; useful for permission probes.

For file:// URLs there is nothing to probe — a local store is returned directly, identical to for_path.

Trait Implementations

impl Clone for UnityObjectStoreFactory

fn clone(&self) -> UnityObjectStoreFactory

Returns a duplicate of the value.

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

Performs copy-assignment from source.