shindan_maker

Struct ShindanClient

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

A client for interacting with ShindanMaker.

Implementations§

Source§

impl ShindanClient

Source

pub fn new(domain: ShindanDomain) -> Result<Self>

Create a new ShindanMaker client.

§Arguments
  • domain - The domain of ShindanMaker to use.
§Returns

A new ShindanMaker client.

§Examples
use shindan_maker::{ShindanClient, ShindanDomain};

let client = ShindanClient::new(ShindanDomain::En).unwrap();
Examples found in repository?
examples/get_title.rs (line 8)
5
6
7
8
9
10
11
12
13
14
15
16
async fn main() -> Result<()> {
    const SHINDAN_ID: &str = "1222992";

    let client = ShindanClient::new(ShindanDomain::En)?;
    let title = client
        .get_title(SHINDAN_ID)
        .await?;

    println!("Title: {}", title);

    Ok(())
}
More examples
Hide additional examples
examples/get_segments.rs (line 9)
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
async fn main() -> Result<()> {
    const SHINDAN_ID: &str = "1222992";
    const USER_NAME: &str = "test_user";

    let client = ShindanClient::new(ShindanDomain::En)?;
    let (segments, title) = client
        .get_segments_with_title(SHINDAN_ID, USER_NAME)
        .await?;

    println!("Result segments: {:#?}", segments);

    println!("Result title: {}", title);
    println!("Result text: {}", segments);

    Ok(())
}
examples/get_html_str.rs (line 16)
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
async fn main() -> Result<()> {
    const SHINDAN_ID: &str = "1222992";
    const USER_NAME: &str = "test_user";
    const OUTPUT_FILE: &str = "shindan.html";

    if Path::new(OUTPUT_FILE).exists() {
        println!("Warning: {} already exists, will be overwritten", OUTPUT_FILE);
    }

    let client = ShindanClient::new(ShindanDomain::En)?;
    let (html_str, title) = client
        .get_html_str_with_title(SHINDAN_ID, USER_NAME)
        .await?;

    println!("Result title: {}", title);

    save_to_file(&html_str, OUTPUT_FILE)?;

    Ok(())
}
Source

pub async fn get_title(&self, id: &str) -> Result<String>

Get the title of a shindan.

§Arguments
  • id - The ID of the shindan.
§Returns

The title of the shindan.

§Examples
use shindan_maker::{ShindanClient, ShindanDomain};

#[tokio::main]
async fn main() {
    let client = ShindanClient::new(ShindanDomain::En).unwrap();

    let title = client
        .get_title("1222992")
        .await
        .unwrap();

    assert_eq!("Fantasy Stats", title);
}
Examples found in repository?
examples/get_title.rs (line 10)
5
6
7
8
9
10
11
12
13
14
15
16
async fn main() -> Result<()> {
    const SHINDAN_ID: &str = "1222992";

    let client = ShindanClient::new(ShindanDomain::En)?;
    let title = client
        .get_title(SHINDAN_ID)
        .await?;

    println!("Title: {}", title);

    Ok(())
}
Source

pub async fn get_segments_with_title( &self, id: &str, name: &str, ) -> Result<(Segments, String)>

Get the segments of a shindan.

§Arguments
  • id - The ID of the shindan.
  • name - The name to use for the shindan.
§Returns

The segments of the shindan and the title of the shindan.

§Examples
use shindan_maker::{ShindanClient, ShindanDomain};

#[tokio::main]
async fn main() {
    let client = ShindanClient::new(ShindanDomain::En).unwrap();

    let (segments, title) = client
        .get_segments_with_title("1222992", "test_user")
        .await
        .unwrap();

    assert_eq!("Fantasy Stats", title);

    println!("Result title: {}", title);
    println!("Result text: {}", segments);

    println!("Result segments: {:#?}", segments);
}
Examples found in repository?
examples/get_segments.rs (line 11)
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
async fn main() -> Result<()> {
    const SHINDAN_ID: &str = "1222992";
    const USER_NAME: &str = "test_user";

    let client = ShindanClient::new(ShindanDomain::En)?;
    let (segments, title) = client
        .get_segments_with_title(SHINDAN_ID, USER_NAME)
        .await?;

    println!("Result segments: {:#?}", segments);

    println!("Result title: {}", title);
    println!("Result text: {}", segments);

    Ok(())
}
Source

pub async fn get_html_str_with_title( &self, id: &str, name: &str, ) -> Result<(String, String)>

Get the HTML string of a shindan.

§Arguments
  • id - The ID of the shindan.
  • name - The name to use for the shindan.
§Returns

The HTML string of the shindan and the title of the shindan.

§Examples
use shindan_maker::{ShindanClient, ShindanDomain};

#[tokio::main]
async fn main() {
    let client = ShindanClient::new(ShindanDomain::En).unwrap();
        
    let (_html_str, title) = client
        .get_html_str_with_title("1222992", "test_user")
        .await
        .unwrap();

    assert_eq!("Fantasy Stats", title);
}
Examples found in repository?
examples/get_html_str.rs (line 18)
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
async fn main() -> Result<()> {
    const SHINDAN_ID: &str = "1222992";
    const USER_NAME: &str = "test_user";
    const OUTPUT_FILE: &str = "shindan.html";

    if Path::new(OUTPUT_FILE).exists() {
        println!("Warning: {} already exists, will be overwritten", OUTPUT_FILE);
    }

    let client = ShindanClient::new(ShindanDomain::En)?;
    let (html_str, title) = client
        .get_html_str_with_title(SHINDAN_ID, USER_NAME)
        .await?;

    println!("Result title: {}", title);

    save_to_file(&html_str, OUTPUT_FILE)?;

    Ok(())
}

Trait Implementations§

Source§

impl Clone for ShindanClient

Source§

fn clone(&self) -> ShindanClient

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ShindanClient

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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