Struct fuel_indexer_lib::config::cli::ApiServerArgs

pub struct ApiServerArgs {

    pub log_level: String,
    pub config: Option<PathBuf>,
    pub fuel_node_host: String,
    pub fuel_node_port: String,
    pub web_api_host: String,
    pub web_api_port: String,
    pub database: String,
    pub max_body_size: usize,
    pub run_migrations: bool,
    pub postgres_user: Option<String>,
    pub postgres_database: Option<String>,
    pub postgres_password: Option<String>,
    pub postgres_host: Option<String>,
    pub postgres_port: Option<String>,
    pub metrics: bool,
    pub auth_enabled: bool,
    pub auth_strategy: Option<String>,
    pub jwt_secret: Option<String>,
    pub jwt_issuer: Option<String>,
    pub jwt_expiry: Option<usize>,
    pub verbose: bool,
    pub rate_limit: bool,
    pub rate_limit_request_count: Option<u64>,
    pub rate_limit_window_size: Option<u64>,
    pub accept_sql_queries: bool,
}

Fields

log_level: String

Log level passed to the Fuel Indexer service.

config: Option<PathBuf>

API server config file.

fuel_node_host: String

Host of the running Fuel node.

fuel_node_port: String

Listening port of the running Fuel node.

web_api_host: String

Web API host.

web_api_port: String

Web API port.

database: String

Database type.

max_body_size: usize

Max body size for web API requests.

run_migrations: bool

Run database migrations before starting service.

postgres_user: Option<String>

Postgres username.

postgres_database: Option<String>

Postgres database.

postgres_password: Option<String>

Postgres password.

postgres_host: Option<String>

Postgres host.

postgres_port: Option<String>

Postgres port.

metrics: bool

Use Prometheus metrics reporting.

auth_enabled: bool

Require users to authenticate for some operations.

auth_strategy: Option<String>

Authentication scheme used.

jwt_secret: Option<String>

Secret used for JWT scheme (if JWT scheme is specified).

jwt_issuer: Option<String>

Issuer of JWT claims (if JWT scheme is specified).

jwt_expiry: Option<usize>

Amount of time (seconds) before expiring token (if JWT scheme is specified).

verbose: bool

Enable verbose logging.

rate_limit: bool

Enable rate limiting.

rate_limit_request_count: Option<u64>

Maximum number of requests to allow over –rate-limit-window..

rate_limit_window_size: Option<u64>

Number of seconds over which to allow –rate-limit-rps.

accept_sql_queries: bool

Allow the web API to accept raw SQL queries.

Trait Implementations

impl Args for ApiServerArgs

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

Append to Command so it can instantiate Self.

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

Append to Command so it can update self.

impl Clone for ApiServerArgs

fn clone(&self) -> ApiServerArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for ApiServerArgs

fn into_app<'b>() -> Command<'b>

Deprecated, replaced with CommandFactory::command

fn into_app_for_update<'b>() -> Command<'b>

Deprecated, replaced with CommandFactory::command_for_update

fn command<'help>() -> App<'help>

Build a Command that can instantiate Self.

fn command_for_update<'help>() -> App<'help>

Build a Command that can update self.

impl Debug for ApiServerArgs

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

Formats the value using the given formatter.

impl From<ApiServerArgs> for IndexerConfig

fn from(args: ApiServerArgs) -> Self

Converts to this type from the input type.

impl FromArgMatches for ApiServerArgs

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 ApiServerArgs

fn parse() -> Self

Parse from std::env::args_os(), 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) -> Selfwhere I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, 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 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.