StoryClient

Struct StoryClient 

Source
pub struct StoryClient { /* private fields */ }
Expand description

Contains methods for story-related API endpoints.

This client provides access to fetching information about stories, story parts, and their content in various formats.

Implementations§

Source§

impl StoryClient

Source

pub async fn get_story_info( &self, story_id: u64, fields: Option<&[StoryField]>, ) -> Result<StoryResponse, WattpadError>

Returns detailed information about a story.

§Arguments
  • story_id - The unique identifier of the story to fetch.
  • fields - An optional slice of StoryField specifying which fields to retrieve. If None, a comprehensive list of all known fields will be requested by default.
§Returns

A Result containing a StoryResponse struct with the story’s metadata on success.

§Errors

Returns a WattpadError if the network request fails or the API returns an error.

§Examples
let client = WattpadClient::new();
let story_id = 12345678; // Example story ID
let fields = &[StoryField::Title, StoryField::VoteCount];

let story_info = client.story.get_story_info(story_id, Some(fields)).await?;

println!("Title: {}", story_info.title);
println!("Votes: {}", story_info.vote_count);
Source

pub async fn get_part_info( &self, part_id: u64, fields: Option<&[PartField]>, ) -> Result<PartResponse, WattpadError>

Returns detailed information about a single story part.

§Arguments
  • part_id - The unique identifier of the story part to fetch.
  • fields - An optional slice of PartField specifying which fields to retrieve. If None, a default set of fields will be requested.
§Returns

A Result containing a PartResponse struct with the part’s metadata on success.

§Errors

Returns a WattpadError if the network request fails or the API returns an error.

§Examples
let client = WattpadClient::new();
let part_id = 87654321; // Example part ID
let fields = &[PartField::Title, PartField::WordCount];

let part_info = client.story.get_part_info(part_id, Some(fields)).await?;

println!("Part Title: {}", part_info.title);
println!("Word Count: {}", part_info.word_count);
Source

pub async fn get_part_content_raw( &self, part_id: u64, ) -> Result<String, WattpadError>

Fetches the raw text content of a single story part.

This endpoint is useful for getting the plain story text without any metadata.

§Arguments
  • part_id - The unique identifier for the story part.
§Returns

A Result containing a String with the raw story text on success.

§Errors

Returns a WattpadError if the network request fails.

§Examples
let client = WattpadClient::new();
let part_id = 87654321;

let content = client.story.get_part_content_raw(part_id).await?;
println!("Fetched content snippet: {}...", content.chars().take(100).collect::<String>());
Source

pub async fn get_part_content_json( &self, part_id: u64, ) -> Result<PartContentResponse, WattpadError>

Fetches the content of a story part as a structured JSON object.

§Arguments
  • part_id - The unique identifier for the story part.
§Returns

A Result containing a PartContentResponse struct with the parsed story content on success.

§Errors

Returns a WattpadError if the network request fails or the JSON response cannot be parsed.

§Examples
let client = WattpadClient::new();
let part_id = 87654321;

let content_json = client.story.get_part_content_json(part_id).await?;
println!("Text from JSON: {}...", content_json.text.chars().take(100).collect::<String>());
Source

pub async fn get_story_content_zip( &self, story_id: u64, ) -> Result<Bytes, WattpadError>

Downloads the text content of an entire story as a single ZIP archive.

The archive contains the story text, typically organized by parts.

§Arguments
  • story_id - The unique identifier for the story (not a part).
§Returns

A Result containing a Bytes object with the binary data of the ZIP file on success.

§Errors

Returns a WattpadError if the network request or download fails.

§Examples
let client = WattpadClient::new();
let story_id = 12345678;

let zip_bytes = client.story.get_story_content_zip(story_id).await?;

// Example: Save the ZIP file to disk
let mut file = File::create(format!("{}.zip", story_id))?;
file.write_all(&zip_bytes)?;

println!("Successfully downloaded and saved {}.zip", story_id);

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,