Struct SessionApi 

pub struct SessionApi { /* private fields */ }

Public entry point for session management. Obtain via crate::IgClient::session.

Implementations

impl SessionApi

pub async fn login(&self) -> Result<SessionInfo>

Log in using the canonical v3 flow (OAuth bearer tokens).

pub async fn login_with_encryption(&self) -> Result<SessionInfo>

Available on crate feature encryption only.

Log in v3 with an RSA-encrypted password instead of plaintext.

Recommended for accounts that hold real funds (live or funded demo). The password is encrypted client-side with IG’s published RSA public key (PKCS#1 v1.5) before being sent over the wire, so it never appears in plaintext in any intermediate proxy or server-side log.

Workflow (handled internally):

1. GET /session/encryptionKey to fetch the public key + timestamp.
2. encrypt_password(password, key, timestamp) (RSA PKCS#1v15).
3. POST /session v3 with encryptedPassword=true.

Behind the optional encryption cargo feature.

Errors

• Error::Api if either the key fetch or the login itself returns a non-2xx response.
• Error::Auth if the encryption step fails (malformed key, bad key/timestamp combination, etc.).

pub async fn login_v2(&self) -> Result<SessionInfo>

Log in using the legacy v2 flow (CST + X-SECURITY-TOKEN response headers). Mainly used by the streaming client which still wants CST/XST.

pub async fn refresh(&self) -> Result<()>

Refresh the v3 access token using the stored refresh token.

pub async fn logout(&self) -> Result<()>

Tear down the current session on the server side and locally.

pub async fn read(&self, fetch_tokens: bool) -> Result<SessionDetails>

Read details about the current session.

When fetch_tokens is true, the server responds with CST and X-SECURITY-TOKEN headers. These are written into the local session state — necessary when an OAuth (v3) session needs CST/XST tokens for the Lightstreamer streaming endpoint.

pub async fn switch_account( &self, account_id: &str, default_account: bool, ) -> Result<SwitchAccountResponse>

Switch the active trading account.

Updates the local session state so that subsequent v3 requests carry the new IG-ACCOUNT-ID header.

pub async fn encryption_key(&self) -> Result<EncryptionKey>

Available on crate feature encryption only.

Fetch the encryption key + timestamp used for encrypted-password login.

Combine with crate::session::encryption::encrypt_password (behind the encryption feature) to build the password field expected by POST /session when encryptedPassword=true.

Trait Implementations

impl Debug for SessionApi

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

Formats the value using the given formatter.