Struct Source 

pub struct Source {

    pub id: String,
    pub label: String,
    pub kind: ProviderKind,
    pub tier: Tier,
    pub origin: String,
    pub s3: S3Settings,
    pub azure: AzureSettings,
    pub project: Option<String>,
    pub profile: Option<String>,
    pub buckets: Vec<String>,
    pub problem: Option<String>,
    pub gcloud: Option<String>,
    pub secret_command: Option<String>,
    pub google_credentials: Option<PathBuf>,
}

One store and the login that reaches it.

Fields

id: String

label: String

Shown on the home screen.

kind: ProviderKind

tier: Tier

origin: String

Which credentials were found, in a word or two: datui config, AWS_PROFILE.

s3: S3Settings

Only meaningful for ProviderKind::S3.

azure: AzureSettings

Only meaningful for ProviderKind::Azure.

project: Option<String>

The GCP project whose buckets are listed.

profile: Option<String>

The AWS profile in use, when one is named.

buckets: Vec<String>

Buckets named in the config, shown even when the login cannot list them.

problem: Option<String>

Why this source cannot be used, when something in its own definition says so.

gcloud: Option<String>

The gcloud configuration whose token a Google source signs with. None is object_store’s own login: the environment or the application-default file.

secret_command: Option<String>

A program that prints an S3 source’s secret access key.

google_credentials: Option<PathBuf>

The Google service account or application-default file a source logs in with.

Implementations

impl Source

pub fn new( kind: ProviderKind, id: impl Into<String>, tier: Tier, origin: impl Into<String>, ) -> Self

A source of kind with nothing known of it but where it was found.

pub fn named_in_urls(&self) -> bool

Whether URLs from this source carry its ID. Only an S3-compatible server other than the default one needs to: its buckets are named only within its endpoint.

pub fn bucket_url(&self, bucket: &str) -> String

The URL of one of this source’s buckets. For Azure, the first level is storage accounts, and an account has no URL of its own, so it is a home-screen place.

pub fn detail(&self) -> Option<String>

The account the buckets belong to, when there is one to name.

pub fn fingerprint(&self) -> String

What this source points at. Anything cached under the source’s ID is stale once this changes: an endpoint moved to another server lists other buckets.

impl Source

pub fn with_credentials(self, env: &Environment<'_>) -> Result<Source, String>

This source with its AWS profile’s signing keys filled in, running credential_process or the AWS CLI if needed: call on a worker.

Trait Implementations

impl Clone for Source

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 Source

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

Formats the value using the given formatter.

impl Eq for Source

impl PartialEq for Source

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Source