Struct AppEnvironment 

pub struct AppEnvironment {

    pub name: String,
    pub version_code: String,
    pub build_number: i32,
    pub log_sql: bool,
    pub server_count: usize,
    pub worker_count: usize,
    pub socket_count: usize,
    pub pg_url: String,
    pub redis_url: String,
    pub rabbitmq_url: String,
    pub rabbitmq_vhost: String,
    pub mongodb_url: String,
    pub es_url: String,
    pub es_api_key: String,
    pub server_port: u16,
    pub socket_port: u16,
    pub prefetch_count: usize,
    pub url: String,
    pub setup_mode: SetupMode,
    pub kind: EnvironmentKind,
    pub process_role: ProcessRole,
    /* private fields */
}

Loaded service configuration. Obtain via AppEnvironment::get after provisioning.

Required keys are SERVICE_NAME, SERVICE_VERSION, BUILD_NUMBER, ENVIRONMENT_KIND, SERVER_PORT, SERVICE_URL, POSTGRESQL_URL, REDIS_URL, RABBITMQ_URL, and MONGODB_URL; loading fails with EnvError::MissingKeys when any are absent.

Fields

name: String

Service name from SERVICE_NAME.

version_code: String

Service version from SERVICE_VERSION.

build_number: i32

Build number from BUILD_NUMBER.

log_sql: bool

Whether SQL statements are logged, from LOG_SQL (defaults to false).

server_count: usize

Number of HTTP server instances, from SERVER_COUNT (defaults to 1).

worker_count: usize

Number of worker instances, from WORKER_COUNT (defaults to 0).

socket_count: usize

Number of socket server instances, from SOCKET_COUNT (defaults to 0).

pg_url: String

Postgres connection URL from POSTGRESQL_URL.

redis_url: String

Redis connection URL from REDIS_URL.

rabbitmq_url: String

RabbitMQ connection URL from RABBITMQ_URL.

rabbitmq_vhost: String

RabbitMQ virtual host from RABBITMQ_VHOST (defaults to "/").

mongodb_url: String

MongoDB connection URL from MONGODB_URL.

es_url: String

Elasticsearch URL from ELASTICSEARCH_URL (defaults to "<none>").

es_api_key: String

Elasticsearch API key from ELASTICSEARCH_API_KEY (defaults to "<none>").

server_port: u16

HTTP listen port from SERVER_PORT.

socket_port: u16

Socket listen port from SOCKET_PORT (defaults to 8081).

prefetch_count: usize

Queue prefetch count from PREFETCH_COUNT (defaults to 1).

url: String

Public service URL from SERVICE_URL.

setup_mode: SetupMode

Setup selector from SETUP_MODE (defaults to production).

kind: EnvironmentKind

Deployment environment selector from ENVIRONMENT_KIND.

process_role: ProcessRole

Process role from PROCESS_ROLE (defaults to worker).

Implementations

impl AppEnvironment

pub fn with_env_file(path: Option<&str>) -> Result<(), EnvError>

Provisions the singleton from the given dotenv file, or from .env plus the process environment when path is None. Idempotent: no-ops when already provisioned.

Returns EnvError::MissingKeys when a required key is absent, or EnvError::InvalidValue when a value fails to parse.

pub fn get() -> &'static Self

Returns the provisioned environment.

Panics when AppEnvironment::with_env_file has not run yet.

pub fn try_get() -> Option<&'static Self>

Returns the provisioned environment, or None when not yet provisioned.

pub fn is_production(&self) -> bool

Reports whether the environment kind is production.

pub fn should_log_sql(&self) -> bool

Reports whether SQL statement logging is enabled (LOG_SQL).

pub fn get_value(&self, key: &str) -> Option<String>

Looks up key in the loaded map, falling back to the process environment. Returns None when absent in both.

pub fn get_required(&self, key: &str) -> Result<String, EnvError>

Looks up key as in AppEnvironment::get_value. Returns EnvError::MissingKeys when absent in both.

Trait Implementations

impl Clone for AppEnvironment

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 AppEnvironment

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

Formats the value using the given formatter.