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

Available on crate feature file_cache only.

Implementations

impl CloudOptions

pub fn default_static_ref() -> &'static Self

impl CloudOptions

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

Set the maximum number of retries.

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

Available on crate feature cloud only.

pub fn with_aws<I: IntoIterator<Item = (AmazonS3ConfigKey, impl Into<String>)>>( self, configs: I, ) -> Self

Available on crate feature aws only.

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

pub async fn build_aws( &self, url: &str, clear_cached_credentials: bool, ) -> PolarsResult<impl ObjectStore>

Available on crate feature aws only.

Build the [object_store::ObjectStore] implementation for AWS.

pub fn with_azure<I: IntoIterator<Item = (AzureConfigKey, impl Into<String>)>>( self, configs: I, ) -> Self

Available on crate feature azure only.

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

pub fn build_azure( &self, url: &str, clear_cached_credentials: bool, ) -> PolarsResult<impl ObjectStore>

Available on crate feature azure only.

Build the [object_store::ObjectStore] implementation for Azure.

pub fn with_gcp<I: IntoIterator<Item = (GoogleConfigKey, impl Into<String>)>>( self, configs: I, ) -> Self

Available on crate feature gcp only.

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

pub fn build_gcp( &self, url: &str, clear_cached_credentials: bool, ) -> PolarsResult<impl ObjectStore>

Available on crate feature gcp only.

Build the [object_store::ObjectStore] implementation for GCP.

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

Available on crate feature http only.

pub fn from_untyped_config<I: IntoIterator<Item = (impl AsRef<str>, impl Into<String>)>>( scheme: Option<&CloudScheme>, config: I, ) -> PolarsResult<Self>

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

Trait Implementations

impl Clone for CloudOptions

fn clone(&self) -> CloudOptions

Returns a duplicate 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

Formats the value using the given formatter.

impl Default for CloudOptions

fn default() -> Self

Returns the “default value” for a type.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for CloudOptions

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

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 JsonSchema for CloudOptions

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

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::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CloudOptions

impl StructuralPartialEq for CloudOptions