Struct AccessTokenInfo

pub struct AccessTokenInfo {
    pub id: AccessTokenId,
    pub expires_at: Option<u32>,
    pub auto_prefix_streams: bool,
    pub scope: Option<AccessTokenScope>,
}

Access token information.

Fields

id: AccessTokenId

Access token ID. It must be unique to the account and between 1 and 50 characters.

expires_at: Option<u32>

Expiration time in seconds since Unix epoch. If not set, the expiration will be set to that of the requestor’s token.

auto_prefix_streams: bool

Namespace streams based on the configured stream-level scope, which must be a prefix. Stream name arguments will be automatically prefixed, and the prefix will be stripped when listing streams.

scope: Option<AccessTokenScope>

Access token scope.

Implementations

impl AccessTokenInfo

pub fn new(id: AccessTokenId) -> Self

Create a new access token info.

Examples found in repository

examples/issue_access_token.rs (line 14)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let token = std::env::var("S2_ACCESS_TOKEN")?;
    let config = ClientConfig::new(token);
    let client = Client::new(config);

    let access_token_id: AccessTokenId = "my-access-token".parse()?;
    let token = client
        .issue_access_token(AccessTokenInfo::new(access_token_id))
        .await?;

    println!("Access token: {token}");

    Ok(())
}

pub fn with_expires_at(self, expires_at: u32) -> Self

Overwrite expiration time.

pub fn with_auto_prefix_streams(self, auto_prefix_streams: bool) -> Self

Overwrite auto prefix streams.

pub fn with_scope(self, scope: AccessTokenScope) -> Self

Overwrite scope.

Trait Implementations

impl Clone for AccessTokenInfo

fn clone(&self) -> AccessTokenInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AccessTokenInfo

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

Formats the value using the given formatter.