Struct AccessTokenScopeInput

Source

#[non_exhaustive]
pub struct AccessTokenScopeInput { /* private fields */ }

Expand description

Scope of an access token.

Note: The final set of permitted operations is the union of ops and the operations permitted by op_group_perms. Also, the final set must not be empty.

See IssueAccessTokenInput::scope.

Implementations§

Source §

impl AccessTokenScopeInput

Source

pub fn from_ops(ops: impl IntoIterator<Item = Operation>) -> Self

Create a new AccessTokenScopeInput with the given permitted operations.

Source

pub fn from_op_group_perms(op_group_perms: OperationGroupPermissions) -> Self

Create a new AccessTokenScopeInput with the given operation group permissions.

Examples found in repository ?

examples/issue_access_token.rs (lines 22-24)

10async fn main() -> Result<(), Box<dyn std::error::Error>> {
11    let access_token =
12        std::env::var("S2_ACCESS_TOKEN").map_err(|_| "S2_ACCESS_TOKEN env var not set")?;
13    let basin_name: BasinName = std::env::var("S2_BASIN")
14        .map_err(|_| "S2_BASIN env var not set")?
15        .parse()?;
16
17    let config = S2Config::new(access_token);
18    let s2 = S2::new(config)?;
19
20    let input = IssueAccessTokenInput::new(
21        "ro-token".parse()?,
22        AccessTokenScopeInput::from_op_group_perms(
23            OperationGroupPermissions::new().with_account(ReadWritePermissions::read_only()),
24        )
25        .with_ops([Operation::CreateStream])
26        .with_streams(StreamMatcher::Prefix("audit".parse()?))
27        .with_basins(BasinMatcher::Exact(basin_name)),
28    );
29    let issued_token = s2.issue_access_token(input).await?;
30    println!("Issued access token: {issued_token}");
31
32    Ok(())
33}

More examples

Hide additional examples

examples/docs_account_and_basins.rs (lines 75-78)

17async fn main() -> Result<(), Box<dyn std::error::Error>> {
18    let access_token = std::env::var("S2_ACCESS_TOKEN")?;
19    let basin_name: BasinName = std::env::var("S2_BASIN")?.parse()?;
20
21    let client = S2::new(S2Config::new(access_token))?;
22
23    // ANCHOR: basin-operations
24    // List basins
25    let basins = client.list_basins(ListBasinsInput::new()).await?;
26
27    // Create a basin
28    client
29        .create_basin(CreateBasinInput::new("my-events".parse()?))
30        .await?;
31
32    // Get configuration
33    let config = client.get_basin_config("my-events".parse()?).await?;
34
35    // Delete
36    client
37        .delete_basin(DeleteBasinInput::new("my-events".parse()?))
38        .await?;
39    // ANCHOR_END: basin-operations
40    println!("Basins: {:?}, config: {:?}", basins, config);
41
42    let basin = client.basin(basin_name);
43
44    // ANCHOR: stream-operations
45    // List streams
46    let streams = basin
47        .list_streams(ListStreamsInput::new().with_prefix("user-".parse()?))
48        .await?;
49
50    // Create a stream
51    // Optionally, pass `.with_config(StreamConfig { .. })` to CreateStreamInput.
52    basin
53        .create_stream(CreateStreamInput::new("user-actions".parse()?))
54        .await?;
55
56    // Get configuration
57    let config = basin.get_stream_config("user-actions".parse()?).await?;
58
59    // Delete
60    basin
61        .delete_stream(DeleteStreamInput::new("user-actions".parse()?))
62        .await?;
63    // ANCHOR_END: stream-operations
64    println!("Streams: {:?}, config: {:?}", streams, config);
65
66    // ANCHOR: access-token-basic
67    // List tokens (returns metadata, not the secret)
68    let tokens = client.list_access_tokens(Default::default()).await?;
69
70    // Issue a token scoped to streams under "users/1234/"
71    let result = client
72        .issue_access_token(
73            IssueAccessTokenInput::new(
74                "user-1234-rw-token".parse()?,
75                AccessTokenScopeInput::from_op_group_perms(
76                    OperationGroupPermissions::new()
77                        .with_stream(ReadWritePermissions::read_write()),
78                )
79                .with_basins(BasinMatcher::Prefix("".parse()?)) // all basins
80                .with_streams(StreamMatcher::Prefix("users/1234/".parse()?)),
81            )
82            .with_expires_at("2027-01-01T00:00:00Z".parse()?),
83        )
84        .await?;
85
86    // Revoke a token
87    client
88        .revoke_access_token("user-1234-rw-token".parse()?)
89        .await?;
90    // ANCHOR_END: access-token-basic
91    println!("Tokens: {:?}, issued: {:?}", tokens, result);
92
93    // ANCHOR: access-token-restricted
94    client
95        .issue_access_token(IssueAccessTokenInput::new(
96            "restricted-token".parse()?,
97            AccessTokenScopeInput::from_op_group_perms(
98                OperationGroupPermissions::new().with_stream(ReadWritePermissions::read_only()),
99            )
100            .with_basins(BasinMatcher::Exact("production".parse()?))
101            .with_streams(StreamMatcher::Prefix("logs/".parse()?)),
102        ))
103        .await?;
104    // ANCHOR_END: access-token-restricted
105
106    // Pagination examples - not executed by default
107    if false {
108        // ANCHOR: pagination
109        // Iterate through all streams with automatic pagination
110        let mut stream = basin.list_all_streams(ListAllStreamsInput::new());
111        while let Some(info) = stream.next().await {
112            let info = info?;
113            println!("{}", info.name);
114        }
115        // ANCHOR_END: pagination
116
117        // ANCHOR: pagination-filtering
118        // List streams with a prefix filter
119        let input = ListAllStreamsInput::new().with_prefix("events/".parse()?);
120        let mut stream = basin.list_all_streams(input);
121        while let Some(info) = stream.next().await {
122            println!("{}", info?.name);
123        }
124        // ANCHOR_END: pagination-filtering
125
126        // ANCHOR: pagination-deleted
127        // Include streams that are being deleted
128        let input = ListAllStreamsInput::new().with_include_deleted(true);
129        let mut stream = basin.list_all_streams(input);
130        while let Some(info) = stream.next().await {
131            let info = info?;
132            println!("{} {:?}", info.name, info.deleted_at);
133        }
134        // ANCHOR_END: pagination-deleted
135    }
136
137    Ok(())
138}

Source

pub fn with_ops(self, ops: impl IntoIterator<Item = Operation>) -> Self

Set the permitted operations.

Examples found in repository ?

examples/issue_access_token.rs (line 25)

10async fn main() -> Result<(), Box<dyn std::error::Error>> {
11    let access_token =
12        std::env::var("S2_ACCESS_TOKEN").map_err(|_| "S2_ACCESS_TOKEN env var not set")?;
13    let basin_name: BasinName = std::env::var("S2_BASIN")
14        .map_err(|_| "S2_BASIN env var not set")?
15        .parse()?;
16
17    let config = S2Config::new(access_token);
18    let s2 = S2::new(config)?;
19
20    let input = IssueAccessTokenInput::new(
21        "ro-token".parse()?,
22        AccessTokenScopeInput::from_op_group_perms(
23            OperationGroupPermissions::new().with_account(ReadWritePermissions::read_only()),
24        )
25        .with_ops([Operation::CreateStream])
26        .with_streams(StreamMatcher::Prefix("audit".parse()?))
27        .with_basins(BasinMatcher::Exact(basin_name)),
28    );
29    let issued_token = s2.issue_access_token(input).await?;
30    println!("Issued access token: {issued_token}");
31
32    Ok(())
33}

Source

pub fn with_op_group_perms( self, op_group_perms: OperationGroupPermissions, ) -> Self

Set the access permissions at the operation group level.

Source

pub fn with_basins(self, basins: BasinMatcher) -> Self

Set the permitted basins.

Defaults to no basins.

Examples found in repository ?

examples/issue_access_token.rs (line 27)

10async fn main() -> Result<(), Box<dyn std::error::Error>> {
11    let access_token =
12        std::env::var("S2_ACCESS_TOKEN").map_err(|_| "S2_ACCESS_TOKEN env var not set")?;
13    let basin_name: BasinName = std::env::var("S2_BASIN")
14        .map_err(|_| "S2_BASIN env var not set")?
15        .parse()?;
16
17    let config = S2Config::new(access_token);
18    let s2 = S2::new(config)?;
19
20    let input = IssueAccessTokenInput::new(
21        "ro-token".parse()?,
22        AccessTokenScopeInput::from_op_group_perms(
23            OperationGroupPermissions::new().with_account(ReadWritePermissions::read_only()),
24        )
25        .with_ops([Operation::CreateStream])
26        .with_streams(StreamMatcher::Prefix("audit".parse()?))
27        .with_basins(BasinMatcher::Exact(basin_name)),
28    );
29    let issued_token = s2.issue_access_token(input).await?;
30    println!("Issued access token: {issued_token}");
31
32    Ok(())
33}

More examples

Hide additional examples

examples/docs_account_and_basins.rs (line 79)

17async fn main() -> Result<(), Box<dyn std::error::Error>> {
18    let access_token = std::env::var("S2_ACCESS_TOKEN")?;
19    let basin_name: BasinName = std::env::var("S2_BASIN")?.parse()?;
20
21    let client = S2::new(S2Config::new(access_token))?;
22
23    // ANCHOR: basin-operations
24    // List basins
25    let basins = client.list_basins(ListBasinsInput::new()).await?;
26
27    // Create a basin
28    client
29        .create_basin(CreateBasinInput::new("my-events".parse()?))
30        .await?;
31
32    // Get configuration
33    let config = client.get_basin_config("my-events".parse()?).await?;
34
35    // Delete
36    client
37        .delete_basin(DeleteBasinInput::new("my-events".parse()?))
38        .await?;
39    // ANCHOR_END: basin-operations
40    println!("Basins: {:?}, config: {:?}", basins, config);
41
42    let basin = client.basin(basin_name);
43
44    // ANCHOR: stream-operations
45    // List streams
46    let streams = basin
47        .list_streams(ListStreamsInput::new().with_prefix("user-".parse()?))
48        .await?;
49
50    // Create a stream
51    // Optionally, pass `.with_config(StreamConfig { .. })` to CreateStreamInput.
52    basin
53        .create_stream(CreateStreamInput::new("user-actions".parse()?))
54        .await?;
55
56    // Get configuration
57    let config = basin.get_stream_config("user-actions".parse()?).await?;
58
59    // Delete
60    basin
61        .delete_stream(DeleteStreamInput::new("user-actions".parse()?))
62        .await?;
63    // ANCHOR_END: stream-operations
64    println!("Streams: {:?}, config: {:?}", streams, config);
65
66    // ANCHOR: access-token-basic
67    // List tokens (returns metadata, not the secret)
68    let tokens = client.list_access_tokens(Default::default()).await?;
69
70    // Issue a token scoped to streams under "users/1234/"
71    let result = client
72        .issue_access_token(
73            IssueAccessTokenInput::new(
74                "user-1234-rw-token".parse()?,
75                AccessTokenScopeInput::from_op_group_perms(
76                    OperationGroupPermissions::new()
77                        .with_stream(ReadWritePermissions::read_write()),
78                )
79                .with_basins(BasinMatcher::Prefix("".parse()?)) // all basins
80                .with_streams(StreamMatcher::Prefix("users/1234/".parse()?)),
81            )
82            .with_expires_at("2027-01-01T00:00:00Z".parse()?),
83        )
84        .await?;
85
86    // Revoke a token
87    client
88        .revoke_access_token("user-1234-rw-token".parse()?)
89        .await?;
90    // ANCHOR_END: access-token-basic
91    println!("Tokens: {:?}, issued: {:?}", tokens, result);
92
93    // ANCHOR: access-token-restricted
94    client
95        .issue_access_token(IssueAccessTokenInput::new(
96            "restricted-token".parse()?,
97            AccessTokenScopeInput::from_op_group_perms(
98                OperationGroupPermissions::new().with_stream(ReadWritePermissions::read_only()),
99            )
100            .with_basins(BasinMatcher::Exact("production".parse()?))
101            .with_streams(StreamMatcher::Prefix("logs/".parse()?)),
102        ))
103        .await?;
104    // ANCHOR_END: access-token-restricted
105
106    // Pagination examples - not executed by default
107    if false {
108        // ANCHOR: pagination
109        // Iterate through all streams with automatic pagination
110        let mut stream = basin.list_all_streams(ListAllStreamsInput::new());
111        while let Some(info) = stream.next().await {
112            let info = info?;
113            println!("{}", info.name);
114        }
115        // ANCHOR_END: pagination
116
117        // ANCHOR: pagination-filtering
118        // List streams with a prefix filter
119        let input = ListAllStreamsInput::new().with_prefix("events/".parse()?);
120        let mut stream = basin.list_all_streams(input);
121        while let Some(info) = stream.next().await {
122            println!("{}", info?.name);
123        }
124        // ANCHOR_END: pagination-filtering
125
126        // ANCHOR: pagination-deleted
127        // Include streams that are being deleted
128        let input = ListAllStreamsInput::new().with_include_deleted(true);
129        let mut stream = basin.list_all_streams(input);
130        while let Some(info) = stream.next().await {
131            let info = info?;
132            println!("{} {:?}", info.name, info.deleted_at);
133        }
134        // ANCHOR_END: pagination-deleted
135    }
136
137    Ok(())
138}

Source

pub fn with_streams(self, streams: StreamMatcher) -> Self

Set the permitted streams.

Defaults to no streams.

Examples found in repository ?

examples/issue_access_token.rs (line 26)

10async fn main() -> Result<(), Box<dyn std::error::Error>> {
11    let access_token =
12        std::env::var("S2_ACCESS_TOKEN").map_err(|_| "S2_ACCESS_TOKEN env var not set")?;
13    let basin_name: BasinName = std::env::var("S2_BASIN")
14        .map_err(|_| "S2_BASIN env var not set")?
15        .parse()?;
16
17    let config = S2Config::new(access_token);
18    let s2 = S2::new(config)?;
19
20    let input = IssueAccessTokenInput::new(
21        "ro-token".parse()?,
22        AccessTokenScopeInput::from_op_group_perms(
23            OperationGroupPermissions::new().with_account(ReadWritePermissions::read_only()),
24        )
25        .with_ops([Operation::CreateStream])
26        .with_streams(StreamMatcher::Prefix("audit".parse()?))
27        .with_basins(BasinMatcher::Exact(basin_name)),
28    );
29    let issued_token = s2.issue_access_token(input).await?;
30    println!("Issued access token: {issued_token}");
31
32    Ok(())
33}

More examples

Hide additional examples

examples/docs_account_and_basins.rs (line 80)

17async fn main() -> Result<(), Box<dyn std::error::Error>> {
18    let access_token = std::env::var("S2_ACCESS_TOKEN")?;
19    let basin_name: BasinName = std::env::var("S2_BASIN")?.parse()?;
20
21    let client = S2::new(S2Config::new(access_token))?;
22
23    // ANCHOR: basin-operations
24    // List basins
25    let basins = client.list_basins(ListBasinsInput::new()).await?;
26
27    // Create a basin
28    client
29        .create_basin(CreateBasinInput::new("my-events".parse()?))
30        .await?;
31
32    // Get configuration
33    let config = client.get_basin_config("my-events".parse()?).await?;
34
35    // Delete
36    client
37        .delete_basin(DeleteBasinInput::new("my-events".parse()?))
38        .await?;
39    // ANCHOR_END: basin-operations
40    println!("Basins: {:?}, config: {:?}", basins, config);
41
42    let basin = client.basin(basin_name);
43
44    // ANCHOR: stream-operations
45    // List streams
46    let streams = basin
47        .list_streams(ListStreamsInput::new().with_prefix("user-".parse()?))
48        .await?;
49
50    // Create a stream
51    // Optionally, pass `.with_config(StreamConfig { .. })` to CreateStreamInput.
52    basin
53        .create_stream(CreateStreamInput::new("user-actions".parse()?))
54        .await?;
55
56    // Get configuration
57    let config = basin.get_stream_config("user-actions".parse()?).await?;
58
59    // Delete
60    basin
61        .delete_stream(DeleteStreamInput::new("user-actions".parse()?))
62        .await?;
63    // ANCHOR_END: stream-operations
64    println!("Streams: {:?}, config: {:?}", streams, config);
65
66    // ANCHOR: access-token-basic
67    // List tokens (returns metadata, not the secret)
68    let tokens = client.list_access_tokens(Default::default()).await?;
69
70    // Issue a token scoped to streams under "users/1234/"
71    let result = client
72        .issue_access_token(
73            IssueAccessTokenInput::new(
74                "user-1234-rw-token".parse()?,
75                AccessTokenScopeInput::from_op_group_perms(
76                    OperationGroupPermissions::new()
77                        .with_stream(ReadWritePermissions::read_write()),
78                )
79                .with_basins(BasinMatcher::Prefix("".parse()?)) // all basins
80                .with_streams(StreamMatcher::Prefix("users/1234/".parse()?)),
81            )
82            .with_expires_at("2027-01-01T00:00:00Z".parse()?),
83        )
84        .await?;
85
86    // Revoke a token
87    client
88        .revoke_access_token("user-1234-rw-token".parse()?)
89        .await?;
90    // ANCHOR_END: access-token-basic
91    println!("Tokens: {:?}, issued: {:?}", tokens, result);
92
93    // ANCHOR: access-token-restricted
94    client
95        .issue_access_token(IssueAccessTokenInput::new(
96            "restricted-token".parse()?,
97            AccessTokenScopeInput::from_op_group_perms(
98                OperationGroupPermissions::new().with_stream(ReadWritePermissions::read_only()),
99            )
100            .with_basins(BasinMatcher::Exact("production".parse()?))
101            .with_streams(StreamMatcher::Prefix("logs/".parse()?)),
102        ))
103        .await?;
104    // ANCHOR_END: access-token-restricted
105
106    // Pagination examples - not executed by default
107    if false {
108        // ANCHOR: pagination
109        // Iterate through all streams with automatic pagination
110        let mut stream = basin.list_all_streams(ListAllStreamsInput::new());
111        while let Some(info) = stream.next().await {
112            let info = info?;
113            println!("{}", info.name);
114        }
115        // ANCHOR_END: pagination
116
117        // ANCHOR: pagination-filtering
118        // List streams with a prefix filter
119        let input = ListAllStreamsInput::new().with_prefix("events/".parse()?);
120        let mut stream = basin.list_all_streams(input);
121        while let Some(info) = stream.next().await {
122            println!("{}", info?.name);
123        }
124        // ANCHOR_END: pagination-filtering
125
126        // ANCHOR: pagination-deleted
127        // Include streams that are being deleted
128        let input = ListAllStreamsInput::new().with_include_deleted(true);
129        let mut stream = basin.list_all_streams(input);
130        while let Some(info) = stream.next().await {
131            let info = info?;
132            println!("{} {:?}", info.name, info.deleted_at);
133        }
134        // ANCHOR_END: pagination-deleted
135    }
136
137    Ok(())
138}

Source

pub fn with_access_tokens(self, access_tokens: AccessTokenMatcher) -> Self

Set the permitted access tokens.

Defaults to no access tokens.

Trait Implementations§

Source §

impl Clone for AccessTokenScopeInput

Source §

fn clone(&self) -> AccessTokenScopeInput

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for AccessTokenScopeInput

Source §

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

Formats the value using the given formatter. Read more

Source §

impl From<AccessTokenScopeInput> for AccessTokenScope

Source §

fn from(value: AccessTokenScopeInput) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl UnwindSafe for AccessTokenScopeInput

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §