Struct OperationGroupPermissions 

#[non_exhaustive]
pub struct OperationGroupPermissions {
    pub account: Option<ReadWritePermissions>,
    pub basin: Option<ReadWritePermissions>,
    pub stream: Option<ReadWritePermissions>,
}

Permissions at the operation group level.

See AccessTokenScope::op_group_perms.

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.

account: Option<ReadWritePermissions>

Account-level access permissions.

Defaults to None.

basin: Option<ReadWritePermissions>

Basin-level access permissions.

Defaults to None.

stream: Option<ReadWritePermissions>

Stream-level access permissions.

Defaults to None.

Implementations

impl OperationGroupPermissions

pub fn new() -> Self

Create a new OperationGroupPermissions with default values.

Examples found in repository

examples/issue_access_token.rs (line 23)

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 read_only_all() -> Self

Create read-only permissions for all groups.

pub fn write_only_all() -> Self

Create write-only permissions for all groups.

pub fn read_write_all() -> Self

Create read-write permissions for all groups.

pub fn with_account(self, account: ReadWritePermissions) -> Self

Set account-level access permissions.

Examples found in repository

examples/issue_access_token.rs (line 23)

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_basin(self, basin: ReadWritePermissions) -> Self

Set basin-level access permissions.

pub fn with_stream(self, stream: ReadWritePermissions) -> Self

Set stream-level access permissions.

Trait Implementations

impl Clone for OperationGroupPermissions

fn clone(&self) -> OperationGroupPermissions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OperationGroupPermissions

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

Formats the value using the given formatter.

impl Default for OperationGroupPermissions

fn default() -> OperationGroupPermissions

Returns the “default value” for a type.

impl From<OperationGroupPermissions> for PermittedOperationGroups

fn from(value: OperationGroupPermissions) -> Self

Converts to this type from the input type.

impl From<PermittedOperationGroups> for OperationGroupPermissions

fn from(value: PermittedOperationGroups) -> Self

Converts to this type from the input type.