torn_api::scopes

Struct ForumScope

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

Implementations§

Source§

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

Source

pub fn new(executor: E) -> Self

Source

pub async fn categories<S>( self, builder: impl FnOnce(ForumCategoriesRequestBuilder<Empty>) -> ForumCategoriesRequestBuilder<S>, ) -> Result<ForumCategoriesResponse, E::Error>
where S: IsComplete,

Get publicly available forum categories

§Description

Requires public access key.

Source

pub async fn posts_for_thread_id<S>( self, thread_id: ForumThreadId, builder: impl FnOnce(ForumPostsForThreadIdRequestBuilder<Empty>) -> ForumPostsForThreadIdRequestBuilder<S>, ) -> Result<ForumPostsResponse, E::Error>
where S: IsComplete,

Get specific forum thread posts

§Description

Requires public access key.
Returns 20 posts per page for a specific thread.

Source

pub async fn thread_for_thread_id<S>( self, thread_id: ForumThreadId, builder: impl FnOnce(ForumThreadForThreadIdRequestBuilder<Empty>) -> ForumThreadForThreadIdRequestBuilder<S>, ) -> Result<ForumThreadResponse, E::Error>
where S: IsComplete,

Get specific thread details

§Description

Requires public access key.
Contains details of a thread including topic content and poll (if any).

Source

pub async fn threads<S>( self, builder: impl FnOnce(ForumThreadsRequestBuilder<Empty>) -> ForumThreadsRequestBuilder<S>, ) -> Result<ForumThreadsResponse, E::Error>
where S: IsComplete,

Get threads across all forum categories

§Description

Requires public access key.

Source

pub async fn threads_for_category_ids<S>( self, category_ids: CategoryIds, builder: impl FnOnce(ForumThreadsForCategoryIdsRequestBuilder<Empty>) -> ForumThreadsForCategoryIdsRequestBuilder<S>, ) -> Result<ForumThreadsResponse, E::Error>
where S: IsComplete,

Get threads for specific public forum category or categories

§Description

Requires public access key.

Source

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

Get all available forum selections

§Description

Requires public access key.

Source

pub async fn timestamp<S>( self, builder: impl FnOnce(ForumTimestampRequestBuilder<Empty>) -> ForumTimestampRequestBuilder<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(ForumRequestBuilder<Empty>) -> ForumRequestBuilder<S>, ) -> Result<Response, E::Error>
where S: IsComplete,

Get any Forum selection

§Description

Requires public access key.
Choose one or more selections (comma separated).

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

impl<E> UnwindSafe for ForumScope<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