WattpadClient

Struct WattpadClient 

Source
pub struct WattpadClient {
    pub user: UserClient,
    pub story: StoryClient,
    /* private fields */
}
Expand description

The main asynchronous client for interacting with the Wattpad API.

This client holds the HTTP connection, manages authentication state, and provides access to categorized sub-clients for different parts of the API.

Fields§

§user: UserClient

Provides access to user-related API endpoints.

§story: StoryClient

Provides access to story and part-related API endpoints.

Implementations§

Source§

impl WattpadClient

Source

pub fn new() -> Self

Creates a new WattpadClient with default settings.

This is now a convenience method that uses the builder.

Source

pub fn builder() -> WattpadClientBuilder

Creates a new builder for configuring a WattpadClient.

This is the new entry point for custom client creation.

Source

pub async fn authenticate( &self, username: &str, password: &str, ) -> Result<(), WattpadError>

Authenticates the client using a username and password.

On a successful login, the API returns session cookies which are automatically stored in the client’s cookie store for use in subsequent requests.

§Arguments
  • username - The Wattpad username.
  • password - The Wattpad password.
§Returns

An empty Ok(()) on successful authentication.

§Errors

Returns WattpadError::AuthenticationFailed if login is unsuccessful.

Source

pub async fn deauthenticate(&self) -> Result<(), WattpadError>

Deauthenticates the client by logging out from Wattpad.

This method sends a request to the logout endpoint, which invalidates the session cookies. It then sets the client’s internal authentication state to false.

§Returns

An empty Ok(()) on successful logout.

§Errors

Returns a WattpadError if the HTTP request fails.

Source

pub fn is_authenticated(&self) -> bool

Checks if the client has been successfully authenticated.

§Returns

true if authenticate has been called successfully, false otherwise.

Trait Implementations§

Source§

impl Default for WattpadClient

Provides a default implementation for WattpadClient.

This is equivalent to calling WattpadClient::new().

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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> 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
Source§

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