Enum ConfigSource 

pub enum ConfigSource {
    File(PathBuf),
    Http(String),
    S3 {
        bucket: String,
        key: String,
    },
    Gcs {
        bucket: String,
        object: String,
    },
    Azure {
        container: String,
        blob: String,
    },
    AppConfig {
        application: String,
        environment: String,
        profile: String,
    },
    AzureAppConfig {
        store: String,
        key: String,
        label: Option<String>,
    },
    DynamoDb {
        table: String,
        id: String,
        key: Option<String>,
        value: Option<String>,
    },
    Firestore {
        project: String,
        document: String,
        database: Option<String>,
        field: Option<String>,
    },
    Cosmos {
        account: String,
        database: String,
        container: String,
        id: String,
        pk: Option<String>,
        field: Option<String>,
    },
}

Variants

File(PathBuf)

Http(String)

https://, or http:// to a loopback host only.

S3

Fields

bucket: String

key: String

Gcs

Fields

bucket: String

object: String

Azure

Fields

container: String

blob: String

AppConfig

An AWS AppConfig configuration profile.

Fields

application: String

environment: String

profile: String

AzureAppConfig

One key-value of an Azure App Configuration store; no label means the unlabelled value.

Fields

store: String

key: String

label: Option<String>

DynamoDb

A DynamoDB item, read by its string partition key (attribute key, default id); the YAML is in attribute value (default config).

Fields

table: String

id: String

key: Option<String>

value: Option<String>

Firestore

A Firestore document (collection/doc, possibly nested); the YAML is in string field field (default config).

Fields

project: String

document: String

database: Option<String>

field: Option<String>

Cosmos

A Cosmos DB item, read by id; its partition key value is pk, or the id itself. The YAML is in string property field (default config).

Fields

account: String

database: String

container: String

id: String

pk: Option<String>

field: Option<String>

Implementations

impl ConfigSource

pub fn parse(raw: &str) -> Result<Self, SignalError>

Parses a $SIGNAL_CONFIG value. Anything without a recognised scheme is a local path.

pub fn parse_list(raw: &str) -> Result<Vec<Self>, SignalError>

Parses a $SIGNAL_CONFIG value that lists one or more files, comma separated, lowest priority first.

pub fn discover() -> Result<Option<Vec<Self>>, SignalError>

$SIGNAL_CONFIG if set, else ./signal.yaml if it exists. A local $SIGNAL_CONFIG path that is not a file is an error rather than a silent fall back to defaults.

pub fn join(&self, reference: &str) -> Result<Self, SignalError>

Resolves an extends entry of this file. A URL or an absolute path is taken as is; anything else is relative to this file’s own location, in the same bucket, container or directory.

A remote file may only extend other remote files: a config served over the network must not be able to read local paths.

pub fn check_supported(&self) -> Result<(), SignalError>

Whether this build can read the source at all, either natively or through a registered ExternalFetcher. A missing one is an install problem, not an outage, so it fails loudly instead of falling back.

pub fn scheme(&self) -> &'static str

The URL scheme, or file for a local path.

pub fn cloud(&self) -> Option<&'static str>

The cloud whose add-on reads this source, if any.

pub fn is_remote(&self) -> bool

pub async fn fetch(&self) -> Result<String, SignalError>

Reads the raw (uninterpolated) config text from the source.

Trait Implementations

impl Clone for ConfigSource

fn clone(&self) -> ConfigSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigSource

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

Formats the value using the given formatter.

impl Display for ConfigSource

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

Formats the value using the given formatter.

impl Eq for ConfigSource

impl PartialEq for ConfigSource

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ConfigSource