Struct ApiInformation

pub struct ApiInformation {
    pub name: Option<String>,
    pub base_url: String,
    pub about: Option<String>,
    pub version: Option<String>,
    pub author: Option<String>,
    pub qualifier: Option<String>,
    pub organisation: Option<String>,
    pub env_prefix: Option<String>,
}

Information block for #[derive(ApiRun)].

Example

#[api(infos(
  base_url = "http://jsonplaceholder.typicode.com",
  name = "jsonplaceholder",
  qualifier = "com",
  organisation = "typicode",
  env_prefix = "JSONPLACEHOLDER"
))]

Fields

name: Option<String>

Name of the application. If omitted, the crate’s name is used. This name appears in help and is used to generate the config’s path.

base_url: String

The base URL of the api. All the endpoints are relative to this URL.

about: Option<String>

Short description of the application. It appears in the help.

version: Option<String>

The version of the application. If omitted, the crate’s version is used.

author: Option<String>

The author of the application. If omitted, the crate’s author is used.

qualifier: Option<String>

A qualifier to generate the configuration path. If omitted, an empty string is used. The qualifier can be the TLD of the application’s url. Example: “com”

organisation: Option<String>

A organisation to generate the configuration path. If omitted, an empty string is used. The organisation can be the domain of the application’s url. Example: “foobar” in “foobar.com”.

env_prefix: Option<String>

A prefix for environment variables.Some parameters can be passed/overried by environment variables (base-url, auth-token). The environment variables will be generate by prefixing this parameter. Example: When env_prefix is “MYAPP” the base_url parameter become MYPAPP_BASE_URL. If omitted, the env_prefix is “APP”.

Trait Implementations

impl Debug for ApiInformation

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

Formats the value using the given formatter.

impl Default for ApiInformation

fn default() -> ApiInformation

Returns the “default value” for a type.

impl FromMeta for ApiInformation

fn from_list(__items: &[NestedMeta]) -> Result<Self>

Create an instance from a list of nested meta items.

fn from_nested_meta(item: &NestedMeta) -> Result<Self, Error>

fn from_meta(item: &Meta) -> Result<Self, Error>

Create an instance from a syn::Meta by dispatching to the format-appropriate trait function. This generally should not be overridden by implementers.

fn from_none() -> Option<Self>

When a field is omitted from a parent meta-item, from_none is used to attempt recovery before a missing field error is generated.

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

Create an instance from the presence of the word in the attribute with no additional options specified.

fn from_value(value: &Lit) -> Result<Self, Error>

Create an instance from a literal value of either foo = "bar" or foo("bar"). This dispatches to the appropriate method based on the type of literal encountered, and generally should not be overridden by implementers.

fn from_expr(expr: &Expr) -> Result<Self, Error>

fn from_char(value: char) -> Result<Self, Error>

Create an instance from a char literal in a value position.

fn from_string(value: &str) -> Result<Self, Error>

Create an instance from a string literal in a value position.

fn from_bool(value: bool) -> Result<Self, Error>

Create an instance from a bool literal in a value position.