orca::net

Struct Connection

Source 
pub struct Connection {
    pub auth: Option<OAuth>,
    pub useragent: HeaderValue,
    pub client: Client<HttpsConnector<HttpConnector>, Body>,
    pub limit: Cell<LimitMethod>,
    /* private fields */
}
Expand description

A connection holder to reddit. Holds authorization info if provided, and is in charge of ratelimiting.

Fields§

§auth: Option<OAuth>

Authorization info (optional, but required for sending authorized requests)

§useragent: HeaderValue

User agent for the client

§client: Client<HttpsConnector<HttpConnector>, Body>

HTTP client

§limit: Cell<LimitMethod>

How to ratelimit (burst or steady)

Implementations§

Source§

impl Connection

Source

pub fn new( appname: &str, appversion: &str, appauthor: &str, ) -> Result<Connection, Error>

Creates a new connection instance to reddit

§Arguments
  • appname - The name of the app
  • appversion - The version of the app
  • appauthor - The author of the app (should be in reddit form as /u/)
Source

pub fn run_request(&self, req: Request<Body>) -> Result<Value, Error>

Send a request to reddit. This is where ratelimiting happens, as well as setting the user agent.

Source

pub fn run_auth_request(&self, req: Request<Body>) -> Result<Value, Error>

Send a request to reddit with authorization headers

Source

pub fn set_limit(&self, limit: LimitMethod)

Set’s the ratelimiting method

Source

pub fn get_core(&self) -> &RefCell<Core>

Returns a reference to the tokio core in a RefCell

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, 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. 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.