Struct Botguard

pub struct Botguard { /* private fields */ }

RustyPipe Botguard client

Implementations

impl Botguard

pub fn builder<'a>() -> BotguardBuilder<'a>

Create a new BotguardBuilder

This is the same as BotguardBuilder::new

pub fn is_from_snapshot(&self) -> bool

Return true if the Botguard instance was recreated from a snapshot

pub fn created_at(&self) -> OffsetDateTime

Get the creation date of the Botguard instance

pub fn lifetime(&self) -> u32

Return the lifetime of the Botguard instance and its tokens in seconds

pub fn valid_until(&self) -> OffsetDateTime

Return the expiry date of the Botguard instance and its tokens

pub async fn mint_token(&mut self, ident: &str) -> Result<String, Error>

Generate a new PO token from an identifier

For a session-bound token used for YouTube stream URLs, use the visitor data ID as an identifier

For a content-bound token used for YouTube player requests (serviceIntegrityDimensions.poToken parameter), use the video ID as an identifier.

pub async fn write_snapshot(self) -> bool

Save a snapshot of the Botguard runtime

Returns true if a snapshot has been successfully written.

This function does nothing if no snapshot path has been specified or the instance has been created from a snapshot.

Snapshotting consumes the runtime, so this function has to be run after using Botguard.