Skip to main content

LoginClient

Struct LoginClient 

Source
pub struct LoginClient<'a> { /* private fields */ }
Expand description

登录领域 API 客户端。

Implementations§

Source§

impl<'a> LoginClient<'a>

Source

pub async fn nav(&self) -> BpiResult<LoginNav>

获取当前会话的导航/登录状态。

Examples found in repository?
examples/module_clients.rs (line 26)
9async fn main() -> BpiResult<()> {
10    let client = client_from_env()?;
11    let video_params = VideoViewParams::from_bvid("BV1xx411c7mD".parse::<Bvid>()?);
12    let bangumi_params = BangumiInfoParams::new(MediaId::new(28_220_978)?);
13
14    if !run_live_example() {
15        println!("module-client 快速示例已编译;设置 BPI_RUN_EXAMPLE=1 后会发起真实网络请求");
16        return Ok(());
17    }
18
19    let video = client.video().view(video_params).await?;
20    println!("video: {}", video.title);
21
22    let bangumi = client.bangumi().info(bangumi_params).await?;
23    println!("bangumi: {}", bangumi.media.title);
24
25    if env::var_os("BPI_COOKIE").is_some() {
26        let nav = client.login().nav().await?;
27        println!("logged in: {}", nav.is_login);
28    }
29
30    Ok(())
31}
More examples
Hide additional examples
examples/login_status.rs (line 19)
15async fn main() -> BpiResult<()> {
16    let client = account::authenticated_client()?;
17    let login = client.login();
18
19    let nav = login.nav().await?;
20    println!(
21        "登录状态: is_login={} mid={:?} uname={}",
22        nav.is_login,
23        nav.mid,
24        nav.uname.as_deref().unwrap_or("<unknown>")
25    );
26
27    let coin = login.coin().await?;
28    println!("硬币余额: {:.2}", coin.money);
29
30    match login.daily_reward().await {
31        Ok(reward) => println!(
32            "每日奖励: login={} watch={} coins={} share={}",
33            reward.login, reward.watch, reward.coins, reward.share
34        ),
35        Err(err) if err.is_risk_control() => {
36            println!("每日奖励: 当前请求被风控拦截,已跳过 ({err})");
37        }
38        Err(err) => return Err(err),
39    }
40
41    let vip = login.vip_info().await?;
42    println!(
43        "VIP: active={} type={} status={}",
44        vip.is_active(),
45        vip.vip_type,
46        vip.vip_status
47    );
48
49    Ok(())
50}
Source

pub async fn stat(&self) -> BpiResult<LoginStats>

获取当前已认证用户的关注数、粉丝数和动态数。

Source

pub async fn coin(&self) -> BpiResult<LoginCoinBalance>

获取当前已认证账号的硬币余额。

Examples found in repository?
examples/login_status.rs (line 27)
15async fn main() -> BpiResult<()> {
16    let client = account::authenticated_client()?;
17    let login = client.login();
18
19    let nav = login.nav().await?;
20    println!(
21        "登录状态: is_login={} mid={:?} uname={}",
22        nav.is_login,
23        nav.mid,
24        nav.uname.as_deref().unwrap_or("<unknown>")
25    );
26
27    let coin = login.coin().await?;
28    println!("硬币余额: {:.2}", coin.money);
29
30    match login.daily_reward().await {
31        Ok(reward) => println!(
32            "每日奖励: login={} watch={} coins={} share={}",
33            reward.login, reward.watch, reward.coins, reward.share
34        ),
35        Err(err) if err.is_risk_control() => {
36            println!("每日奖励: 当前请求被风控拦截,已跳过 ({err})");
37        }
38        Err(err) => return Err(err),
39    }
40
41    let vip = login.vip_info().await?;
42    println!(
43        "VIP: active={} type={} status={}",
44        vip.is_active(),
45        vip.vip_type,
46        vip.vip_status
47    );
48
49    Ok(())
50}
Source

pub async fn today_coin_exp(&self) -> BpiResult<LoginTodayCoinExp>

获取今天通过投币操作获得的经验值。

Source

pub async fn daily_reward(&self) -> BpiResult<LoginDailyReward>

获取当前已认证账号的每日奖励完成状态。

Examples found in repository?
examples/login_status.rs (line 30)
15async fn main() -> BpiResult<()> {
16    let client = account::authenticated_client()?;
17    let login = client.login();
18
19    let nav = login.nav().await?;
20    println!(
21        "登录状态: is_login={} mid={:?} uname={}",
22        nav.is_login,
23        nav.mid,
24        nav.uname.as_deref().unwrap_or("<unknown>")
25    );
26
27    let coin = login.coin().await?;
28    println!("硬币余额: {:.2}", coin.money);
29
30    match login.daily_reward().await {
31        Ok(reward) => println!(
32            "每日奖励: login={} watch={} coins={} share={}",
33            reward.login, reward.watch, reward.coins, reward.share
34        ),
35        Err(err) if err.is_risk_control() => {
36            println!("每日奖励: 当前请求被风控拦截,已跳过 ({err})");
37        }
38        Err(err) => return Err(err),
39    }
40
41    let vip = login.vip_info().await?;
42    println!(
43        "VIP: active={} type={} status={}",
44        vip.is_active(),
45        vip.vip_type,
46        vip.vip_status
47    );
48
49    Ok(())
50}
Source

pub async fn account_info(&self) -> BpiResult<LoginAccountInfo>

获取当前已认证账号的个人资料。

Source

pub async fn vip_info(&self) -> BpiResult<LoginVipInfo>

获取当前已认证账号的 VIP 状态。

Examples found in repository?
examples/login_status.rs (line 41)
15async fn main() -> BpiResult<()> {
16    let client = account::authenticated_client()?;
17    let login = client.login();
18
19    let nav = login.nav().await?;
20    println!(
21        "登录状态: is_login={} mid={:?} uname={}",
22        nav.is_login,
23        nav.mid,
24        nav.uname.as_deref().unwrap_or("<unknown>")
25    );
26
27    let coin = login.coin().await?;
28    println!("硬币余额: {:.2}", coin.money);
29
30    match login.daily_reward().await {
31        Ok(reward) => println!(
32            "每日奖励: login={} watch={} coins={} share={}",
33            reward.login, reward.watch, reward.coins, reward.share
34        ),
35        Err(err) if err.is_risk_control() => {
36            println!("每日奖励: 当前请求被风控拦截,已跳过 ({err})");
37        }
38        Err(err) => return Err(err),
39    }
40
41    let vip = login.vip_info().await?;
42    println!(
43        "VIP: active={} type={} status={}",
44        vip.is_active(),
45        vip.vip_type,
46        vip.vip_status
47    );
48
49    Ok(())
50}
Source

pub async fn notice( &self, params: LoginNoticeParams, ) -> BpiResult<LoginNoticeData>

获取已认证账号的指定登录通知。

Source

pub async fn log(&self, params: LoginLogParams) -> BpiResult<LoginLogData>

获取已认证账号的近期登录日志条目。

Source

pub async fn generate_captcha(&self) -> BpiResult<GenerateCaptcha>

为登录流程生成 Geetest 验证码挑战。

Source

pub async fn qr_generate(&self) -> BpiResult<GenerateQrCodeData>

生成 QR 登录 URL 和临时轮询 key。

Source

pub async fn qr_poll( &self, params: LoginQrPollParams, ) -> BpiResult<CheckQrCodeStatusData>

轮询 QR 登录状态。

Source§

impl<'a> LoginClient<'a>

Source

pub async fn logout(&self, params: LogoutWebParams) -> BpiResult<LogoutData>

登出当前 Web 会话并返回标准 payload 结果。

Source§

impl<'a> LoginClient<'a>

Source

pub async fn send_sms_code( &self, params: LoginSmsCodeParams, ) -> BpiResult<SMSSendData>

发送短信验证码(Web端)

Source

pub async fn login_with_sms( &self, cid: u32, tel: u32, captcha_key: &str, code: &str, ) -> Result<(), String>

短信登录

  • cid - 国际冠字码
  • tel - 手机号码
  • captcha_key - 短信登录 token(基于send_sms_code)
  • code - 短信验证码 5min过期
Source§

impl<'a> LoginClient<'a>

Source

pub async fn update_user_sign( &self, params: LoginUserSignParams, ) -> BpiResult<Option<Value>>

更新会员中心用户签名并返回标准 payload 结果。

Trait Implementations§

Source§

impl<'a> Clone for LoginClient<'a>

Source§

fn clone(&self) -> LoginClient<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for LoginClient<'a>

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for LoginClient<'a>

§

impl<'a> !UnwindSafe for LoginClient<'a>

§

impl<'a> Freeze for LoginClient<'a>

§

impl<'a> Send for LoginClient<'a>

§

impl<'a> Sync for LoginClient<'a>

§

impl<'a> Unpin for LoginClient<'a>

§

impl<'a> UnsafeUnpin for LoginClient<'a>

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, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

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

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: Sized + 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: Sized + 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> Same for T

Source§

type Output = T

Should always be Self
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