Struct IssueAccessTokenInput 

#[non_exhaustive]
pub struct IssueAccessTokenInput {
    pub id: AccessTokenId,
    pub expires_at: Option<S2DateTime>,
    pub auto_prefix_streams: bool,
    pub scope: AccessTokenScopeInput,
}

Input for issue_access_token.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: AccessTokenId

Access token ID.

expires_at: Option<S2DateTime>

Expiration time.

Defaults to the expiration time of requestor’s access token passed via S2Config.

auto_prefix_streams: bool

Whether to automatically prefix stream names during creation and strip the prefix during listing.

Note: scope.streams must be set with the prefix.

Defaults to false.

scope: AccessTokenScopeInput

Scope of the token.

Implementations

impl IssueAccessTokenInput

pub fn new(id: AccessTokenId, scope: AccessTokenScopeInput) -> Self

Create a new IssueAccessTokenInput with the given id and scope.

Examples found in repository

examples/issue_access_token.rs (lines 20-28)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let access_token =
        std::env::var("S2_ACCESS_TOKEN").map_err(|_| "S2_ACCESS_TOKEN env var not set")?;
    let basin_name: BasinName = std::env::var("S2_BASIN")
        .map_err(|_| "S2_BASIN env var not set")?
        .parse()?;

    let config = S2Config::new(access_token);
    let s2 = S2::new(config)?;

    let input = IssueAccessTokenInput::new(
        "ro-token".parse()?,
        AccessTokenScopeInput::from_op_group_perms(
            OperationGroupPermissions::new().with_account(ReadWritePermissions::read_only()),
        )
        .with_ops([Operation::CreateStream])
        .with_streams(StreamMatcher::Prefix("audit".parse()?))
        .with_basins(BasinMatcher::Exact(basin_name)),
    );
    let issued_token = s2.issue_access_token(input).await?;
    println!("Issued access token: {issued_token}");

    Ok(())
}

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

Set the expiration time.

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

Set whether to automatically prefix stream names during creation and strip the prefix during listing.

Trait Implementations

impl Clone for IssueAccessTokenInput

fn clone(&self) -> IssueAccessTokenInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IssueAccessTokenInput

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

Formats the value using the given formatter.

impl From<IssueAccessTokenInput> for AccessTokenInfo

fn from(value: IssueAccessTokenInput) -> Self

Converts to this type from the input type.