Struct RedditClient

Source
pub struct RedditClient { /* private fields */ }

Implementations§

Source§

impl RedditClient

Source

pub async fn from_env(client_name: &str) -> Result<Self, RedditError>

Creates a new client, reading from the REDDIT_CLIENT_ID and REDDIT_CLIENT_SECRET for the client_id and client_secret, respectively. This function uses dotenv, so the variables can be kept in a .env file at the root of the workspace.

§Errors

This function will error if the credentials provided in the aformentioned environment variables are not able to authenticate on Reddit.

§Panics

This function will panic if either of the aformentioned environment variables are not present.

Source

pub async fn try_from_env( client_name: &str, ) -> Result<Result<Self, RedditError>, MissingEnvVariableError>

Creates a new client, reading from the REDDIT_CLIENT_ID and REDDIT_CLIENT_SECRET for the client_id and client_secret, respectively. This function uses dotenv, so the variables can be kept in a .env file at the root of the workspace.

§Errors

This function will error if the aformentioned environment variables are not present or if the credentials provided in them are not able to authenticate on Reddit.

Source

pub async fn from_config( __arg0: Config<'_>, ) -> Result<Result<Self, RedditError>, MissingEnvVariableError>

Creates a new client with the provided Config. See the documentation of Config for more information.

§Errors

This function will error if the aformentioned environment variables are not present or if the credentials provided in them are not able to authenticate on Reddit.

Source

pub async fn get_subreddit_posts( &mut self, subreddit: &str, sorting: Sort, after: Option<&FullName>, ) -> Result<RedditListing, RedditError>

Gets posts from a subreddit, using the specified sorting and after options.

§Errors

This function will error for many reasons. See the documentation for RedditError for more information.

§Panics

This function will panic if either of the aformentioned environment variables are not present.

Source

pub async fn get_comments(&mut self) -> Result<Vec<RedditListing>, RedditError>

Gets the comments for the provided post.

§Errors

This function will error for many reasons. See the documentation for RedditError for more information.

Auto Trait Implementations§

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