Struct EsiBuilder 

pub struct EsiBuilder { /* private fields */ }

Builder for the Esi struct.

Example

let mut esi = EsiBuilder::new()
    .user_agent("some user agent")
    .client_id("your_client_id")
    .client_secret("your_client_secret")
    .callback_url("your_callback_url")
    .build()
    .unwrap();

Overriding the API specification

If you will be creating multiple struct instances, you will probably run into the issue of needing to retrieve the API spec on each. Given that this operation is fairly expensive (certainly as far as the rest of the API endpoints that EVE makes available), this builder supports setting that struct:

let mut esi = EsiBuilder::new()
    .user_agent("some user agent")
    .spec(Some(your_spec))
    .build()
    .unwrap();

Note that this “spec” function is just another builder function; you can make use it alongside all of the others. Note also that this is entirely optional: if you don’t mind retrieving the spec from ESI on each of your struct instances, you can safely ignore this.

Not including client info

If you are only making calls to non-authenticated endpoints, then you don’t need to make use of the authentication flow, which means you don’t need a client ID, client secret, and callback URL. In this case, you can construct your client without those parameters:

let mut esi = EsiBuilder::new()
    .user_agent("some user agent")
    .build()
    .unwrap();

Note that you still need to set the user agent, as this is good API usage behavior.

Implementations

impl EsiBuilder

pub fn new() -> Self

Start a new builder.

pub fn compatibility_date(self, val: &str) -> Self

Set the compatibility header to use.

Will default to a hardcoded value if not set.

pub fn client_id(self, val: &str) -> Self

Set the client_id.

pub fn client_secret(self, val: &str) -> Self

Set the client_secret (https://docs.esi.evetech.net/docs/sso/web_based_sso_flow.html).

pub fn enable_application_authentication(self, val: bool) -> Self

Enable PKCE Authentication flow for Applications (https://docs.esi.evetech.net/docs/sso/native_sso_flow.html)

pub fn callback_url(self, val: &str) -> Self

Set the callback_url.

pub fn base_api_url(self, val: &str) -> Self

Set the base_api_url.

pub fn authorize_url(self, val: &str) -> Self

Set the authorize_url.

pub fn token_url(self, val: &str) -> Self

Set the token_url.

pub fn spec_url(self, val: &str) -> Self

Set the spec_url.

pub fn scope(self, val: &str) -> Self

Set the scope.

pub fn access_token(self, val: Option<&str>) -> Self

Set the access_token.

pub fn access_expiration(self, val: Option<i64>) -> Self

Set the access_expiration.

pub fn refresh_token(self, val: Option<&str>) -> Self

Set the refresh_token.

pub fn user_agent(self, val: &str) -> Self

Set the user_agent.

pub fn http_timeout(self, val: Option<u64>) -> Self

Set the timeout to use in millis when sending HTTP requests.

Will default to 60,000 (1 minute) if not set.

pub fn spec(self, spec: Option<Spec>) -> Self

Explicitly set the OpenAPI specification.

Allows copying the spec from another Esi struct or other source, avoiding fetching the spec from ESI again. May be useful given the runtime cost of retrieving the spec.

Be aware of the potential for out-of-date data.

pub fn cache_max_entries(self, val: usize) -> Self

Limit how many responses the cache keeps (1024 by default). When it is full, expired entries are dropped first and then the oldest ones. Has no effect unless the cache is enabled with EsiBuilder::enable_cache.

pub fn cache_max_bytes(self, val: usize) -> Self

Limit how many bytes the cache keeps (no limit by default), counting the bodies, validators, headers and keys it stores. It applies together with EsiBuilder::cache_max_entries: when a response does not fit in either limit, entries are dropped in the same order. A response larger than the limit by itself is not cached. Has no effect unless the cache is enabled with EsiBuilder::enable_cache.

pub fn rate_limit_policy(self, val: RateLimitPolicy) -> Self

Choose what the client does when a route group has no rate-limit tokens left for a request (RateLimitPolicy::Off by default): wait until the request fits, or fail without calling ESI.

The balance is tracked per route group and access token, from the X-Ratelimit-* headers of the responses, and only for operations that declare a group in the spec, so the spec must be loaded.

pub fn page_concurrency(self, val: usize) -> Self

How many pages Esi::fetch_all_pages requests at the same time once it knows the page count (4 by default; 1 makes it sequential).

pub fn language(self, val: Language) -> Self

Set the language of the responses (the Accept-Language header).

ESI answers in English when it is not set.

pub fn tenant(self, val: &str) -> Self

Set the tenant (the X-Tenant header). ESI uses tranquility when it is not set.

pub fn enable_cache(self, val: bool) -> Self

Keep GET responses in memory and revalidate them with ETag / Last-Modified (disabled by default).

While an entry is younger than the operation’s x-client-cache-ttl in the spec (or the max-age of the response when the spec has none) it is served without calling ESI; afterwards it is revalidated and a 304 Not Modified reuses the stored body. Entries are kept per access token.

pub fn build(self) -> EsiResult<Esi>

Construct the Esi instance.

There are a few things that could go wrong, like not setting one of the mandatory fields or providing a user agent that is not a valid HTTP header value.

Trait Implementations

impl Clone for EsiBuilder

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 EsiBuilder

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

Formats the value using the given formatter.

impl Default for EsiBuilder

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EsiBuilder

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for EsiBuilder

impl PartialEq for EsiBuilder

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for EsiBuilder

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EsiBuilder