eve_esi 0.4.9

Thread-safe, asynchronous client for EVE Online's ESI & OAuth2
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

//! # EVE ESI Scopes
//!
//! This module provides the [`ScopeBuilder`] & related modules with methods to build a list of scopes to request during
//! login in a type-safe manner.
//!
//! For an overview & usage examples of OAuth2 with the `eve_esi` crate, see the [module-level documentation](super)
//!
//! ## Modules
//! | Module           | Description                                                                                          |
//! | ---------------- | ---------------------------------------------------------------------------------------------------- |
//! | [`builder`]      | Provides the [`ScopeBuilder`] to build a list of scopes                                              |
//! | [`characters`]   | Provides the [`CharactersScopes`] struct to be used with the [`ScopeBuilder::characters`] method     |
//! | [`corporations`] | Provides the [`CorporationsScopes`] struct to be used with the [`ScopeBuilder::corporations`] method |
//! | [`wallet`]       | Provides the [`WalletScopes`] struct to be used with the [`ScopeBuilder::wallet`] method             |
//!
//! ## Usage Example
//!
//! ```rust
//! use eve_esi::ScopeBuilder;
//! use eve_esi::scope::CharactersScopes;
//!
//! // Create a new scope builder
//! let scopes = ScopeBuilder::new()
//!     // Add `publicData` scope
//!     .public_data()
//!     // Add character scopes
//!     .characters(
//!         CharactersScopes::new()
//!             .read_agents_research()
//!     )
//!     // Build the scopes into Vec<String>
//!     .build();
//!
//! // Use with `esi_client.oauth2().login_url(scopes)` method...
//! ```
//!
//! See the [`crate::oauth2::login`] module documentation for an example of usage of the [`ScopeBuilder`] with the
//! [`login_url`](crate::oauth2::OAuth2Endpoints::login_url) method.

pub mod builder;

pub mod alliances;
pub mod assets;
pub mod calendar;
pub mod characters;
pub mod clones;
pub mod contracts;
pub mod corporations;
pub mod fittings;
pub mod fleets;
pub mod industry;
pub mod killmails;
pub mod location;
pub mod mail;
pub mod markets;
pub mod planets;
pub mod search;
pub mod skills;
pub mod ui;
pub mod universe;
pub mod wallet;

pub use builder::ScopeBuilder;

pub use alliances::AlliancesScopes;
pub use assets::AssetsScopes;
pub use calendar::CalendarScopes;
pub use characters::CharactersScopes;
pub use clones::ClonesScopes;
pub use contracts::ContractsScopes;
pub use corporations::CorporationsScopes;
pub use fittings::FittingsScopes;
pub use fleets::FleetsScopes;
pub use industry::IndustryScopes;
pub use killmails::KillmailsScopes;
pub use location::LocationScopes;
pub use mail::MailScopes;
pub use markets::MarketsScopes;
pub use planets::PlanetsScopes;
pub use search::SearchScopes;
pub use skills::SkillsScopes;
pub use ui::UiScopes;
pub use universe::UniverseScopes;
pub use wallet::WalletScopes;