Struct CloudOptions

pub struct CloudOptions {
    pub max_retries: usize,
    pub file_cache_ttl: u64,
    /* private fields */
}

Options to connect to various cloud providers.

Fields

max_retries: usize

file_cache_ttl: u64

Implementations

impl CloudOptions

pub fn default_static_ref() -> &'static CloudOptions

impl CloudOptions

pub fn with_max_retries(self, max_retries: usize) -> CloudOptions

Set the maximum number of retries.

pub fn with_credential_provider( self, credential_provider: Option<PlCredentialProvider>, ) -> CloudOptions

pub fn with_aws<I>(self, configs: I) -> CloudOptions

where I: IntoIterator<Item = (AmazonS3ConfigKey, impl Into<String>)>,

Set the configuration for AWS connections. This is the preferred API from rust.

pub async fn build_aws( &self, url: &str, ) -> Result<impl ObjectStore, PolarsError>

Build the object_store::ObjectStore implementation for AWS.

pub fn with_azure<I>(self, configs: I) -> CloudOptions

where I: IntoIterator<Item = (AzureConfigKey, impl Into<String>)>,

Set the configuration for Azure connections. This is the preferred API from rust.

pub fn build_azure(&self, url: &str) -> Result<impl ObjectStore, PolarsError>

Build the object_store::ObjectStore implementation for Azure.

pub fn with_gcp<I>(self, configs: I) -> CloudOptions

where I: IntoIterator<Item = (GoogleConfigKey, impl Into<String>)>,

Set the configuration for GCP connections. This is the preferred API from rust.

pub fn build_gcp(&self, url: &str) -> Result<impl ObjectStore, PolarsError>

Build the object_store::ObjectStore implementation for GCP.

pub fn build_http(&self, url: &str) -> Result<impl ObjectStore, PolarsError>

pub fn from_untyped_config<I>( url: &str, config: I, ) -> Result<CloudOptions, PolarsError>

where I: IntoIterator<Item = (impl AsRef<str>, impl Into<String>)>,

Parse a configuration from a Hashmap. This is the interface from Python.

Trait Implementations

impl Clone for CloudOptions

fn clone(&self) -> CloudOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CloudOptions

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

Formats the value using the given formatter.

impl Default for CloudOptions

fn default() -> CloudOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CloudOptions

fn deserialize<__D>( __deserializer: __D, ) -> Result<CloudOptions, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for CloudOptions

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CloudOptions

fn eq(&self, other: &CloudOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CloudOptions

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CloudOptions

impl StructuralPartialEq for CloudOptions