Struct BpiClient 

pub struct BpiClient { /* private fields */ }

Bilibili API client.

Implementations

impl BpiClient

pub fn new() -> Result<Self, BpiError>

Creates an owned client with default configuration.

pub fn builder() -> BpiClientBuilder

Starts configuring a client.

Examples found in repository

examples/module_clients.rs (line 35)

fn client_from_env() -> BpiResult<BpiClient> {
    match env::var("BPI_COOKIE") {
        Ok(cookie) if !cookie.trim().is_empty() => BpiClient::builder().cookie(cookie).build(),
        _ => BpiClient::builder().build(),
    }
}

pub fn set_account(&self, account: Account) -> Result<(), BpiError>

Sets account information and updates this client’s cookie state.

pub fn clear_account(&self)

Clears account information from this client.

pub fn set_account_from_cookie_str( &self, cookie_str: &str, ) -> Result<(), BpiError>

Sets account information from a raw Cookie header string.

pub fn has_login_cookies(&self) -> bool

Checks whether this client has login cookies.

pub fn get_account(&self) -> Option<Account>

Returns the current account information.

pub fn csrf(&self) -> Result<String, BpiError>

Gets the current CSRF token from account information.

pub fn get(&self, url: &str) -> RequestBuilder

Creates a GET request with this client’s default Bilibili headers.

pub fn post(&self, url: &str) -> RequestBuilder

Creates a POST request with this client’s default Bilibili headers.

impl BpiClient

pub fn activity(&self) -> ActivityClient<'_>

Creates an activity domain client.

pub fn article(&self) -> ArticleClient<'_>

Creates an article domain client.

pub fn audio(&self) -> AudioClient<'_>

Creates an audio domain client.

pub fn bangumi(&self) -> BangumiClient<'_>

Creates a bangumi domain client.

Examples found in repository

examples/module_clients.rs (line 22)

async fn main() -> BpiResult<()> {
    let client = client_from_env()?;
    let video_params = VideoViewParams::from_bvid("BV1xx411c7mD".parse::<Bvid>()?);
    let bangumi_params = BangumiInfoParams::new(MediaId::new(28_220_978)?);

    if !run_live_example() {
        println!("module-client quickstart compiled; set BPI_RUN_EXAMPLE=1 to call live APIs");
        return Ok(());
    }

    let video = client.video().view(video_params).await?;
    println!("video: {}", video.title);

    let bangumi = client.bangumi().info(bangumi_params).await?;
    println!("bangumi: {}", bangumi.media.title);

    if env::var_os("BPI_COOKIE").is_some() {
        let nav = client.login().nav().await?;
        println!("logged in: {}", nav.is_login);
    }

    Ok(())
}

pub fn cheese(&self) -> CheeseClient<'_>

Creates a cheese course domain client.

pub fn clientinfo(&self) -> ClientInfoClient<'_>

Creates a client info domain client.

pub fn comment(&self) -> CommentClient<'_>

Creates a comment domain client.

pub fn creativecenter(&self) -> CreativeCenterClient<'_>

Creates a creative center domain client.

pub fn danmaku(&self) -> DanmakuClient<'_>

Creates a danmaku domain client.

pub fn dynamic(&self) -> DynamicClient<'_>

Creates a dynamic domain client.

pub fn electric(&self) -> ElectricClient<'_>

Creates an electric charging domain client.

pub fn fav(&self) -> FavClient<'_>

Creates a favorite domain client.

pub fn historytoview(&self) -> HistoryToViewClient<'_>

Creates a history and to-view domain client.

pub fn login(&self) -> LoginClient<'_>

Creates a login domain client.

Examples found in repository

examples/module_clients.rs (line 26)

async fn main() -> BpiResult<()> {
    let client = client_from_env()?;
    let video_params = VideoViewParams::from_bvid("BV1xx411c7mD".parse::<Bvid>()?);
    let bangumi_params = BangumiInfoParams::new(MediaId::new(28_220_978)?);

    if !run_live_example() {
        println!("module-client quickstart compiled; set BPI_RUN_EXAMPLE=1 to call live APIs");
        return Ok(());
    }

    let video = client.video().view(video_params).await?;
    println!("video: {}", video.title);

    let bangumi = client.bangumi().info(bangumi_params).await?;
    println!("bangumi: {}", bangumi.media.title);

    if env::var_os("BPI_COOKIE").is_some() {
        let nav = client.login().nav().await?;
        println!("logged in: {}", nav.is_login);
    }

    Ok(())
}

pub fn live(&self) -> LiveClient<'_>

Creates a live domain client.

pub fn manga(&self) -> MangaClient<'_>

Creates a manga domain client.

pub fn misc(&self) -> MiscClient<'_>

Creates a misc domain client.

pub fn message(&self) -> MessageClient<'_>

Creates a message domain client.

pub fn note(&self) -> NoteClient<'_>

Creates a note domain client.

pub fn opus(&self) -> OpusClient<'_>

Creates an opus domain client.

pub fn search(&self) -> SearchClient<'_>

Creates a search domain client.

pub fn video(&self) -> VideoClient<'_>

Creates a video domain client.

Examples found in repository

examples/module_clients.rs (line 19)

async fn main() -> BpiResult<()> {
    let client = client_from_env()?;
    let video_params = VideoViewParams::from_bvid("BV1xx411c7mD".parse::<Bvid>()?);
    let bangumi_params = BangumiInfoParams::new(MediaId::new(28_220_978)?);

    if !run_live_example() {
        println!("module-client quickstart compiled; set BPI_RUN_EXAMPLE=1 to call live APIs");
        return Ok(());
    }

    let video = client.video().view(video_params).await?;
    println!("video: {}", video.title);

    let bangumi = client.bangumi().info(bangumi_params).await?;
    println!("bangumi: {}", bangumi.media.title);

    if env::var_os("BPI_COOKIE").is_some() {
        let nav = client.login().nav().await?;
        println!("logged in: {}", nav.is_login);
    }

    Ok(())
}

pub fn video_ranking(&self) -> VideoRankingClient<'_>

Creates a video ranking domain client.

pub fn vip(&self) -> VipClient<'_>

Creates a VIP domain client.

pub fn wallet(&self) -> WalletClient<'_>

Creates a wallet domain client.

pub fn user(&self) -> UserClient<'_>

Creates a user domain client.

pub fn web_widget(&self) -> WebWidgetClient<'_>

Creates a web widget domain client.

pub fn from_config(config: &Account) -> Result<Self, BpiError>

Creates a client from structured account configuration.