torn_api::scopes

Struct FactionScope

Source 
pub struct FactionScope<E>(/* private fields */)
where
    E: Executor;

Implementations§

Source§

impl<E> FactionScope<E>
where E: Executor,

Source

pub fn new(executor: E) -> Self

Source

pub async fn applications<S>( self, builder: impl FnOnce(FactionApplicationsRequestBuilder<Empty>) -> FactionApplicationsRequestBuilder<S>, ) -> Result<FactionApplicationsResponse, E::Error>
where S: IsComplete,

Get your faction’s applications

§Description

Requires minimal access key with faction API access permissions.

Source

pub async fn attacks<S>( self, builder: impl FnOnce(FactionAttacksRequestBuilder<Empty>) -> FactionAttacksRequestBuilder<S>, ) -> Result<FactionAttacksResponse, E::Error>
where S: IsComplete,

Get your faction’s detailed attacks

§Description

Requires limited access key with faction API access permissions.

Source

pub async fn attacksfull<S>( self, builder: impl FnOnce(FactionAttacksfullRequestBuilder<Empty>) -> FactionAttacksfullRequestBuilder<S>, ) -> Result<FactionAttacksFullResponse, E::Error>
where S: IsComplete,

Get your faction’s simplified attacks

§Description

Requires limited access key with faction API access permissions.

Source

pub async fn balance<S>( self, builder: impl FnOnce(FactionBalanceRequestBuilder<Empty>) -> FactionBalanceRequestBuilder<S>, ) -> Result<FactionBalanceResponse, E::Error>
where S: IsComplete,

Get your faction’s & member’s balance details

§Description

Requires limited access key with faction API access permissions.

Source

pub async fn basic<S>( self, builder: impl FnOnce(FactionBasicRequestBuilder<Empty>) -> FactionBasicRequestBuilder<S>, ) -> Result<FactionBasicResponse, E::Error>
where S: IsComplete,

Get your faction’s basic details

§Description

Requires public access key.
The ‘is_enlisted’ value will be populated if you have API faction permissions (with custom, limited or full access keys), otherwise it will be set as null.

Source

pub async fn basic_for_id<S>( self, id: FactionId, builder: impl FnOnce(FactionBasicForIdRequestBuilder<Empty>) -> FactionBasicForIdRequestBuilder<S>, ) -> Result<FactionBasicResponse, E::Error>
where S: IsComplete,

Get a faction’s basic details

§Description

Requires public access key.
The ‘is_enlisted’ value will be populated if you’re requesting data for your faction and have faction permissions (with custom, limited or full access keys), otherwise it will be set as null.

Source

pub async fn chain<S>( self, builder: impl FnOnce(FactionChainRequestBuilder<Empty>) -> FactionChainRequestBuilder<S>, ) -> Result<FactionOngoingChainResponse, E::Error>
where S: IsComplete,

Get your faction’s current chain

§Description

Requires public access key.

Source

pub async fn chain_for_id<S>( self, id: FactionId, builder: impl FnOnce(FactionChainForIdRequestBuilder<Empty>) -> FactionChainForIdRequestBuilder<S>, ) -> Result<FactionOngoingChainResponse, E::Error>
where S: IsComplete,

Get a faction’s current chain

§Description

Requires public access key.

Source

pub async fn chains<S>( self, builder: impl FnOnce(FactionChainsRequestBuilder<Empty>) -> FactionChainsRequestBuilder<S>, ) -> Result<FactionChainsResponse, E::Error>
where S: IsComplete,

Get a list of your faction’s completed chains

§Description

Requires public access key.

Source

pub async fn chains_for_id<S>( self, id: FactionId, builder: impl FnOnce(FactionChainsForIdRequestBuilder<Empty>) -> FactionChainsForIdRequestBuilder<S>, ) -> Result<FactionChainsResponse, E::Error>
where S: IsComplete,

Get a list of a faction’s completed chains

§Description

Requires public access key.

Source

pub async fn chainreport<S>( self, builder: impl FnOnce(FactionChainreportRequestBuilder<Empty>) -> FactionChainreportRequestBuilder<S>, ) -> Result<FactionChainReportResponse, E::Error>
where S: IsComplete,

Get your faction’s latest chain report

§Description

Requires public access key.
This includes currently ongoing chains.

Source

pub async fn chainreport_for_chain_id<S>( self, chain_id: ChainId, builder: impl FnOnce(FactionChainreportForChainIdRequestBuilder<Empty>) -> FactionChainreportForChainIdRequestBuilder<S>, ) -> Result<FactionChainReportResponse, E::Error>
where S: IsComplete,

Get a chain report

§Description

Requires public access key.
Chain reports for ongoing chains are available only for your own faction.

Source

pub async fn contributors<S>( self, builder: impl FnOnce(FactionContributorsRequestBuilder<Empty>) -> FactionContributorsRequestBuilder<S>, ) -> Result<FactionContributorsResponse, E::Error>
where S: IsComplete,

Get your faction’s challenge contributors

§Description

Requires limiteed access key with faction API access permissions.

Source

pub async fn crimes<S>( self, builder: impl FnOnce(FactionCrimesRequestBuilder<Empty>) -> FactionCrimesRequestBuilder<S>, ) -> Result<FactionCrimesResponse, E::Error>
where S: IsComplete,

Get your faction’s organized crimes

§Description

Requires minimal access key with faction API access permissions.
It’s possible to get older entries either by timestamp range (from, to) or with offset.

Source

pub async fn crime_for_crime_id<S>( self, crime_id: FactionCrimeId, builder: impl FnOnce(FactionCrimeForCrimeIdRequestBuilder<Empty>) -> FactionCrimeForCrimeIdRequestBuilder<S>, ) -> Result<FactionCrimeResponse, E::Error>
where S: IsComplete,

Get a specific organized crime

§Description

Requires minimal access key with faction API access permissions.

Source

pub async fn hof<S>( self, builder: impl FnOnce(FactionHofRequestBuilder<Empty>) -> FactionHofRequestBuilder<S>, ) -> Result<FactionHofResponse, E::Error>
where S: IsComplete,

Get your faction’s hall of fame rankings.

§Description

Requires public access key.

Source

pub async fn hof_for_id<S>( self, id: FactionId, builder: impl FnOnce(FactionHofForIdRequestBuilder<Empty>) -> FactionHofForIdRequestBuilder<S>, ) -> Result<FactionHofResponse, E::Error>
where S: IsComplete,

Get a faction’s hall of fame rankings.

§Description

Requires public access key.

Source

pub async fn members<S>( self, builder: impl FnOnce(FactionMembersRequestBuilder<Empty>) -> FactionMembersRequestBuilder<S>, ) -> Result<FactionMembersResponse, E::Error>
where S: IsComplete,

Get a list of your faction’s members

§Description

Requires public access key.
The ‘revive_setting’ value will be populated (not Unknown) if you have faction permissions (with custom, limited or full access keys), otherwise it will be set as ‘Unknown’.

Source

pub async fn members_for_id<S>( self, id: FactionId, builder: impl FnOnce(FactionMembersForIdRequestBuilder<Empty>) -> FactionMembersForIdRequestBuilder<S>, ) -> Result<FactionMembersResponse, E::Error>
where S: IsComplete,

Get a list of a faction’s members

§Description

Requires public access key.
The ‘revive_setting’ value will be populated (not Unknown) if you’re requesting data for your own faction and have faction permissions (with custom, limited or full access keys), otherwise it will be set as ‘Unknown’.

Source

pub async fn news<S>( self, builder: impl FnOnce(FactionNewsRequestBuilder<Empty>) -> FactionNewsRequestBuilder<S>, ) -> Result<FactionNewsResponse, E::Error>
where S: IsComplete,

Get your faction’s news details

§Description

Requires minimal access key with faction API access permissions.
It is possible to pass up to 10 categories at the time (comma separated). Categories ‘attack’, ‘depositFunds’ and ‘giveFunds’ are only available with ‘Custom’, ‘Limited’ or ‘Full’ access keys.

Source

pub async fn positions<S>( self, builder: impl FnOnce(FactionPositionsRequestBuilder<Empty>) -> FactionPositionsRequestBuilder<S>, ) -> Result<FactionPositionsResponse, E::Error>
where S: IsComplete,

Get your faction’s positions details

§Description

Requires minimal access key with faction API access permissions.

Source

pub async fn rackets<S>( self, builder: impl FnOnce(FactionRacketsRequestBuilder<Empty>) -> FactionRacketsRequestBuilder<S>, ) -> Result<FactionRacketsReponse, E::Error>
where S: IsComplete,

Get a list of current rackets

§Description

Requires public access key.

Source

pub async fn rankedwars<S>( self, builder: impl FnOnce(FactionRankedwarsRequestBuilder<Empty>) -> FactionRankedwarsRequestBuilder<S>, ) -> Result<FactionRankedWarResponse, E::Error>
where S: IsComplete,

Get ranked wars list

§Description

Requires public access key.
When category ‘all’ is chosen, you can use ‘from’, ‘to’ & ‘sort’ query parameters.
When category ‘ongoing’ is chosen, all currently active ranked wars are returned.
When no category is chosen, this selection will return ranked war history of your own faction (if any).

Source

pub async fn rankedwars_for_id<S>( self, id: FactionId, builder: impl FnOnce(FactionRankedwarsForIdRequestBuilder<Empty>) -> FactionRankedwarsForIdRequestBuilder<S>, ) -> Result<FactionRankedWarResponse, E::Error>
where S: IsComplete,

Get a faction’s ranked wars history

§Description

Requires public access key.

Source

pub async fn rankedwarreport_for_ranked_war_id<S>( self, ranked_war_id: RankedWarId, builder: impl FnOnce(FactionRankedwarreportForRankedWarIdRequestBuilder<Empty>) -> FactionRankedwarreportForRankedWarIdRequestBuilder<S>, ) -> Result<FactionRankedWarReportResponse, E::Error>
where S: IsComplete,

Get ranked war details

§Description

Requires public access key.

Source

pub async fn reports<S>( self, builder: impl FnOnce(FactionReportsRequestBuilder<Empty>) -> FactionReportsRequestBuilder<S>, ) -> Result<ReportsResponse, E::Error>
where S: IsComplete,

Get faction reports

§Description

Requires limited access key.

  • The default limit is set to 25. However, the limit can be set to 100 for the ‘stats’ category.
Source

pub async fn revives<S>( self, builder: impl FnOnce(FactionRevivesRequestBuilder<Empty>) -> FactionRevivesRequestBuilder<S>, ) -> Result<RevivesResponse, E::Error>
where S: IsComplete,

Get your faction’s detailed revives

§Description

Requires limited access key with faction API access permissions.

Source

pub async fn revives_full<S>( self, builder: impl FnOnce(FactionRevivesFullRequestBuilder<Empty>) -> FactionRevivesFullRequestBuilder<S>, ) -> Result<RevivesFullResponse, E::Error>
where S: IsComplete,

Get your faction’s simplified revives

§Description

Requires limited access key with faction API access permissions.

Source

pub async fn search<S>( self, builder: impl FnOnce(FactionSearchRequestBuilder<Empty>) -> FactionSearchRequestBuilder<S>, ) -> Result<FactionSearchResponse, E::Error>
where S: IsComplete,

Search factions by name or other criteria

§Description

Requires public access key.
This selection is standalone and cannot be used together with other selections.

Source

pub async fn stats<S>( self, builder: impl FnOnce(FactionStatsRequestBuilder<Empty>) -> FactionStatsRequestBuilder<S>, ) -> Result<FactionStatsResponse, E::Error>
where S: IsComplete,

Get your faction’s challenges stats

§Description

Requires minimal access key with faction API access permissions.

Source

pub async fn territory<S>( self, builder: impl FnOnce(FactionTerritoryRequestBuilder<Empty>) -> FactionTerritoryRequestBuilder<S>, ) -> Result<FactionTerritoriesReponse, E::Error>
where S: IsComplete,

Get a list of your faction’s territories

§Description

Requires public access key.

Source

pub async fn territory_for_id<S>( self, id: FactionId, builder: impl FnOnce(FactionTerritoryForIdRequestBuilder<Empty>) -> FactionTerritoryForIdRequestBuilder<S>, ) -> Result<FactionTerritoriesReponse, E::Error>
where S: IsComplete,

Get a list of a faction’s territories

§Description

Requires public access key.

Source

pub async fn territoryownership<S>( self, builder: impl FnOnce(FactionTerritoryownershipRequestBuilder<Empty>) -> FactionTerritoryownershipRequestBuilder<S>, ) -> Result<FactionTerritoriesOwnershipResponse, E::Error>
where S: IsComplete,

Get a list of your faction’s territories

§Description

Requires public access key.

Source

pub async fn territorywars<S>( self, builder: impl FnOnce(FactionTerritorywarsRequestBuilder<Empty>) -> FactionTerritorywarsRequestBuilder<S>, ) -> Result<FactionTerritoryWarsResponse, E::Error>
where S: IsComplete,

Get territory wars list

§Description

Requires public access key.
When category ‘finished’ is chosen, you can use ‘from’, ‘to’ & ‘sort’ query parameters.
When category ‘ongoing’ is chosen, all currently active territory wars are returned.
When no category is chosen, this selection will return territory war history of your own faction (if any).

Source

pub async fn territorywars_for_id<S>( self, id: FactionId, builder: impl FnOnce(FactionTerritorywarsForIdRequestBuilder<Empty>) -> FactionTerritorywarsForIdRequestBuilder<S>, ) -> Result<FactionTerritoryWarsHistoryResponse, E::Error>
where S: IsComplete,

Get a faction’s territory wars history

§Description

Requires public access key.

Source

pub async fn territorywarreport_for_territory_war_id<S>( self, territory_war_id: TerritoryWarId, builder: impl FnOnce(FactionTerritorywarreportForTerritoryWarIdRequestBuilder<Empty>) -> FactionTerritorywarreportForTerritoryWarIdRequestBuilder<S>, ) -> Result<FactionTerritoryWarReportResponse, E::Error>
where S: IsComplete,

Get territory war details

§Description

Requires public access key.

Source

pub async fn upgrades<S>( self, builder: impl FnOnce(FactionUpgradesRequestBuilder<Empty>) -> FactionUpgradesRequestBuilder<S>, ) -> Result<FactionUpgradesResponse, E::Error>
where S: IsComplete,

Get your faction’s upgrades

§Description

Requires minimal access key with faction API access permissions.

Source

pub async fn wars<S>( self, builder: impl FnOnce(FactionWarsRequestBuilder<Empty>) -> FactionWarsRequestBuilder<S>, ) -> Result<FactionWarsResponse, E::Error>
where S: IsComplete,

Get your faction’s wars & pacts details

§Description

Requires public access key.

Source

pub async fn wars_for_id<S>( self, id: FactionId, builder: impl FnOnce(FactionWarsForIdRequestBuilder<Empty>) -> FactionWarsForIdRequestBuilder<S>, ) -> Result<FactionWarsResponse, E::Error>
where S: IsComplete,

Get a faction’s wars & pacts details

§Description

Requires public access key.

Source

pub async fn lookup<S>( self, builder: impl FnOnce(FactionLookupRequestBuilder<Empty>) -> FactionLookupRequestBuilder<S>, ) -> Result<FactionLookupResponse, E::Error>
where S: IsComplete,

§Description

Requires public access key.

Source

pub async fn timestamp<S>( self, builder: impl FnOnce(FactionTimestampRequestBuilder<Empty>) -> FactionTimestampRequestBuilder<S>, ) -> Result<TimestampResponse, E::Error>
where S: IsComplete,

Get current server time

§Description

Requires public access key.

Source

pub async fn for_selections<S>( self, builder: impl FnOnce(FactionRequestBuilder<Empty>) -> FactionRequestBuilder<S>, ) -> Result<Response, E::Error>
where S: IsComplete,

Get any Faction selection

§Description

Key access level depends on the required selections.
Choose one or more selections (comma separated).

Auto Trait Implementations§

§

impl<E> Freeze for FactionScope<E>
where E: Freeze,

§

impl<E> RefUnwindSafe for FactionScope<E>
where E: RefUnwindSafe,

§

impl<E> Send for FactionScope<E>
where E: Send,

§

impl<E> Sync for FactionScope<E>
where E: Sync,

§

impl<E> Unpin for FactionScope<E>
where E: Unpin,

§

impl<E> UnwindSafe for FactionScope<E>
where E: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T