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
impl StoryClient
Sourcepub async fn get_story_info(
&self,
story_id: u64,
fields: Option<&[StoryField]>,
) -> Result<StoryResponse, WattpadError>
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 ofStoryField
specifying which fields to retrieve. IfNone
, 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);
Sourcepub async fn get_part_info(
&self,
part_id: u64,
fields: Option<&[PartField]>,
) -> Result<PartResponse, WattpadError>
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 ofPartField
specifying which fields to retrieve. IfNone
, 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);
Sourcepub async fn get_part_content_raw(
&self,
part_id: u64,
) -> Result<String, WattpadError>
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>());
Sourcepub async fn get_part_content_json(
&self,
part_id: u64,
) -> Result<PartContentResponse, WattpadError>
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>());
Sourcepub async fn get_story_content_zip(
&self,
story_id: u64,
) -> Result<Bytes, WattpadError>
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);