BulkFactionScope

torn_api::scopes

Struct BulkFactionScope 

Source 
pub struct BulkFactionScope<E>
where
    E: BulkExecutor,
{ /* private fields */ }

Implementations§

Source§

impl<E> BulkFactionScope<E>
where E: BulkExecutor,

Source

pub fn new(executor: E) -> Self

Source

pub fn basic_for_id<S, I, B>( self, ids: I, builder: B, ) -> impl Stream<Item = (FactionId, Result<FactionBasicResponse, E::Error>)>
where I: IntoIterator<Item = FactionId>, S: IsComplete, B: Fn(FactionBasicForIdRequestBuilder<Empty>) -> FactionBasicForIdRequestBuilder<S>,

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 fn chain_for_id<S, I, B>( self, ids: I, builder: B, ) -> impl Stream<Item = (FactionId, Result<FactionOngoingChainResponse, E::Error>)>
where I: IntoIterator<Item = FactionId>, S: IsComplete, B: Fn(FactionChainForIdRequestBuilder<Empty>) -> FactionChainForIdRequestBuilder<S>,

Get a faction’s current chain

§Description

Requires public access key.

Source

pub fn chains_for_id<S, I, B>( self, ids: I, builder: B, ) -> impl Stream<Item = (FactionId, Result<FactionChainsResponse, E::Error>)>
where I: IntoIterator<Item = FactionId>, S: IsComplete, B: Fn(FactionChainsForIdRequestBuilder<Empty>) -> FactionChainsForIdRequestBuilder<S>,

Get a list of a faction’s completed chains

§Description

Requires public access key.

Source

pub fn chainreport_for_chain_id<S, I, B>( self, ids: I, builder: B, ) -> impl Stream<Item = (ChainId, Result<FactionChainReportResponse, E::Error>)>
where I: IntoIterator<Item = ChainId>, S: IsComplete, B: Fn(FactionChainreportForChainIdRequestBuilder<Empty>) -> FactionChainreportForChainIdRequestBuilder<S>,

Get a chain report

§Description

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

Source

pub fn crime_for_crime_id<S, I, B>( self, ids: I, builder: B, ) -> impl Stream<Item = (FactionCrimeId, Result<FactionCrimeResponse, E::Error>)>
where I: IntoIterator<Item = FactionCrimeId>, S: IsComplete, B: Fn(FactionCrimeForCrimeIdRequestBuilder<Empty>) -> FactionCrimeForCrimeIdRequestBuilder<S>,

Get a specific organized crime

§Description

Requires minimal access key with faction API access permissions.

Source

pub fn hof_for_id<S, I, B>( self, ids: I, builder: B, ) -> impl Stream<Item = (FactionId, Result<FactionHofResponse, E::Error>)>
where I: IntoIterator<Item = FactionId>, S: IsComplete, B: Fn(FactionHofForIdRequestBuilder<Empty>) -> FactionHofForIdRequestBuilder<S>,

Get a faction’s hall of fame rankings.

§Description

Requires public access key.

Source

pub fn members_for_id<S, I, B>( self, ids: I, builder: B, ) -> impl Stream<Item = (FactionId, Result<FactionMembersResponse, E::Error>)>
where I: IntoIterator<Item = FactionId>, S: IsComplete, B: Fn(FactionMembersForIdRequestBuilder<Empty>) -> FactionMembersForIdRequestBuilder<S>,

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 fn raidreport_for_raid_war_id<S, I, B>( self, ids: I, builder: B, ) -> impl Stream<Item = (RaidWarId, Result<FactionRaidWarReportResponse, E::Error>)>
where I: IntoIterator<Item = RaidWarId>, S: IsComplete, B: Fn(FactionRaidreportForRaidWarIdRequestBuilder<Empty>) -> FactionRaidreportForRaidWarIdRequestBuilder<S>,

Get raid war details

§Description

Requires public access key.

Source

pub fn raids_for_id<S, I, B>( self, ids: I, builder: B, ) -> impl Stream<Item = (FactionId, Result<FactionRaidsResponse, E::Error>)>
where I: IntoIterator<Item = FactionId>, S: IsComplete, B: Fn(FactionRaidsForIdRequestBuilder<Empty>) -> FactionRaidsForIdRequestBuilder<S>,

Get a faction’s raids history

§Description

Requires public access key.

Source

pub fn rankedwars_for_id<S, I, B>( self, ids: I, builder: B, ) -> impl Stream<Item = (FactionId, Result<FactionRankedWarResponse, E::Error>)>
where I: IntoIterator<Item = FactionId>, S: IsComplete, B: Fn(FactionRankedwarsForIdRequestBuilder<Empty>) -> FactionRankedwarsForIdRequestBuilder<S>,

Get a faction’s ranked wars history

§Description

Requires public access key.
Use offset to get older results which are always ordered descending.

Source

pub fn rankedwarreport_for_ranked_war_id<S, I, B>( self, ids: I, builder: B, ) -> impl Stream<Item = (RankedWarId, Result<FactionRankedWarReportResponse, E::Error>)>
where I: IntoIterator<Item = RankedWarId>, S: IsComplete, B: Fn(FactionRankedwarreportForRankedWarIdRequestBuilder<Empty>) -> FactionRankedwarreportForRankedWarIdRequestBuilder<S>,

Get ranked war details

§Description

Requires public access key.

Source

pub fn territory_for_id<S, I, B>( self, ids: I, builder: B, ) -> impl Stream<Item = (FactionId, Result<FactionTerritoriesResponse, E::Error>)>
where I: IntoIterator<Item = FactionId>, S: IsComplete, B: Fn(FactionTerritoryForIdRequestBuilder<Empty>) -> FactionTerritoryForIdRequestBuilder<S>,

Get a list of a faction’s territories

§Description

Requires public access key.

Source

pub fn territorywars_for_id<S, I, B>( self, ids: I, builder: B, ) -> impl Stream<Item = (FactionId, Result<FactionTerritoryWarsHistoryResponse, E::Error>)>
where I: IntoIterator<Item = FactionId>, S: IsComplete, B: Fn(FactionTerritorywarsForIdRequestBuilder<Empty>) -> FactionTerritorywarsForIdRequestBuilder<S>,

Get a faction’s territory wars history

§Description

Requires public access key.

Source

pub fn territorywarreport_for_territory_war_id<S, I, B>( self, ids: I, builder: B, ) -> impl Stream<Item = (TerritoryWarId, Result<FactionTerritoryWarReportResponse, E::Error>)>
where I: IntoIterator<Item = TerritoryWarId>, S: IsComplete, B: Fn(FactionTerritorywarreportForTerritoryWarIdRequestBuilder<Empty>) -> FactionTerritorywarreportForTerritoryWarIdRequestBuilder<S>,

Get territory war details

§Description

Requires public access key.

Source

pub fn wars_for_id<S, I, B>( self, ids: I, builder: B, ) -> impl Stream<Item = (FactionId, Result<FactionWarsResponse, E::Error>)>
where I: IntoIterator<Item = FactionId>, S: IsComplete, B: Fn(FactionWarsForIdRequestBuilder<Empty>) -> FactionWarsForIdRequestBuilder<S>,

Get a faction’s wars & pacts details

§Description

Requires public access key.

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

impl<E> UnwindSafe for BulkFactionScope<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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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