Struct iqps_backend::env::EnvVars

pub struct EnvVars {

    pub db_name: String,
    pub db_host: String,
    pub db_port: String,
    pub db_user: String,
    pub db_password: String,
    pub gh_client_id: String,
    pub gh_client_secret: String,
    pub gh_org_name: String,
    pub gh_org_team_slug: String,
    pub gh_org_admin_token: String,
    jwt_secret: String,
    pub max_upload_limit: usize,
    pub log_location: PathBuf,
    static_files_url: String,
    static_file_storage_location: PathBuf,
    uploaded_qps_path: PathBuf,
    library_qps_path: PathBuf,
    pub server_port: i32,
    pub cors_allowed_origins: String,
    pub paths: Paths,
}

Fields

db_name: String

Database name

db_host: String

Database hostname

db_port: String

Database port

db_user: String

Database username

db_password: String

Database password

gh_client_id: String

OAuth app client id (public token)

gh_client_secret: String

OAuth app client secret

gh_org_name: String

Github organization name

gh_org_team_slug: String

Github organization team slug (this team has access to admin dashboard)

gh_org_admin_token: String

An org admin’s Github token (with the read:org permission)

jwt_secret: String

JWT encryption secret (make it a long, randomized string)

max_upload_limit: usize

Maximum number of papers that can be uploaded at a time

log_location: PathBuf

Location where logs are stored

static_files_url: String

The URL of the static files server (odin’s vault)

static_file_storage_location: PathBuf

The path where static files are served from

uploaded_qps_path: PathBuf

The path where uploaded papers are stored temporarily, relative to the static_file_storage_location

library_qps_path: PathBuf

The path where library papers (scrapped) are stored, relative to the static_file_storage_location

server_port: i32

The port the server listens on

cors_allowed_origins: String

List of origins allowed (as a list of values separated by commas origin1, origin2)

paths: Paths

All paths must be handled using this

Implementations

impl EnvVars

pub fn process(self) -> Result<Self, Box<dyn Error>>

Processes the environment variables after reading.

pub fn get_jwt_key(&self) -> Result<Hmac<Sha256>, InvalidLength>

Returns the JWT signing key

Trait Implementations

impl Args for EnvVars

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl Clone for EnvVars

fn clone(&self) -> EnvVars

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for EnvVars

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl FromArgMatches for EnvVars

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for EnvVars

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.