Struct CloudConfig 

pub struct CloudConfig {
    pub s3_endpoint_url: Option<String>,
    pub s3_access_key_id: Option<String>,
    pub s3_secret_access_key: Option<String>,
    pub s3_region: Option<String>,
    pub connections: Vec<CloudConnectionConfig>,
    pub hide: Vec<String>,
    pub use_azure_account_keys: bool,
    pub env_files: Vec<String>,
    pub instance_identity: bool,
    pub discover: Option<CloudDiscover>,
    pub list_on_start: bool,
    pub dataset_access: Vec<DatasetAccess>,
}

Fields

s3_endpoint_url: Option<String>

The S3 endpoint, keys and region the environment gives (AWS_*): not keys of the file, where a secret would sit in plain text. [[cloud.connections]] names a store’s variables instead.

s3_access_key_id: Option<String>

s3_secret_access_key: Option<String>

s3_region: Option<String>

connections: Vec<CloudConnectionConfig>

Stores named in [[cloud.connections]], beside the ones found on the machine.

hide: Vec<String>

Source IDs never shown on the home screen.

use_azure_account_keys: bool

Read an Azure account with its access keys when a sign-in has no data role, as the Portal does.

env_files: Vec<String>

Files to read cloud variables from, relative to the working directory: .env. Only known cloud variable names are taken, and nothing is exported.

instance_identity: bool

Use the identity of the cloud VM datui runs on (EC2, GCE, Azure). Finding it is a request to a metadata service, so it is off unless the platform says so.

discover: Option<CloudDiscover>

Which logins found on this machine become home-screen sources. Unset means all.

list_on_start: bool

List every source’s buckets when the home screen opens. Off: a source is listed when it is entered or on Ctrl+R, and its credential command runs only then.

dataset_access: Vec<DatasetAccess>

How the object-store datasets of the catalogs are read. Not a key: derived from the catalogs by AppConfig, so resolving a URL needs only this section.

Implementations

impl CloudConfig

pub fn from_env(var: &dyn Fn(&str) -> Option<String>) -> Self

The S3 settings the environment sets. The variable list lives here and nowhere else, so discovery, listing and opening cannot disagree about it. var is the environment, passed in so a test can supply one.

pub fn overlay(&mut self, over: Self)

Lay the environment’s S3 settings over these: each one over gives wins, and a blank value says nothing. Nothing else in over is read.

pub fn validate(&self) -> Result<()>

Reject [[cloud.connections]] entries that would be silently wrong.

Trait Implementations

impl Clone for CloudConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CloudConfig

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

Formats the value using the given formatter.

impl Default for CloudConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CloudConfig

where CloudConfig: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CloudConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.