Struct Session 

pub struct Session { /* private fields */ }

Cookie, score, and user-data state associated with a crawling identity.

use millipede_core::session::{Session, SessionConfig};
let session = Session::new(SessionConfig::default());
assert!(session.id().as_str().starts_with("session-"));

Implementations

impl Session

pub fn new(config: SessionConfig) -> Self

Creates an empty session with a generated identifier.

pub fn id(&self) -> &SessionId

Returns this session’s identifier.

pub fn cookie_jar(&self) -> &Arc<CookieJar>

Returns the authoritative shared cookie jar.

pub async fn with_user_data<R>(&self, f: impl FnOnce(&UserData) -> R) -> R

Reads user data through a synchronous closure, releasing the lock on return.

pub async fn update_user_data(&self, f: impl FnOnce(&mut UserData))

Mutates user data through a synchronous closure, releasing the lock on return.

pub async fn error_score(&self) -> f32

Returns the error score in unscaled units.

pub async fn usage_count(&self) -> u32

Returns the number of attempts served.

pub async fn record_usage(&self)

Records one checkout attempt. Session pools call this when serving a session.

pub async fn is_blocked(&self) -> bool

Returns whether the error threshold has been reached.

pub fn is_expired(&self) -> bool

Returns whether the fixed creation-time expiry has passed.

pub async fn is_retired(&self) -> bool

Returns whether the session was explicitly retired.

pub async fn is_usable(&self) -> bool

Returns whether the session can serve another attempt.

pub async fn mark_good(&self)

Decreases the error score, flooring it at zero.

pub async fn mark_bad(&self)

Adds one scaled error point, saturating at u32::MAX.

pub async fn retire(&self)

Permanently retires this session.

pub fn set_cookies_from_response(&self, response: &HttpResponse)

Stores Set-Cookie headers synchronously and infallibly.

Trait Implementations

impl Debug for Session

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

Formats the value using the given formatter.