docs_account_and_basins/
docs_account_and_basins.rs

1//! Documentation examples for Account and Basins page.
2//!
3//! Run with: cargo run --example docs_account_and_basins
4
5use futures::StreamExt;
6use s2_sdk::{
7    S2,
8    types::{
9        AccessTokenScopeInput, BasinMatcher, BasinName, CreateBasinInput, CreateStreamInput,
10        DeleteBasinInput, DeleteStreamInput, IssueAccessTokenInput, ListAllStreamsInput,
11        ListBasinsInput, ListStreamsInput, OperationGroupPermissions, ReadWritePermissions,
12        S2Config, StreamMatcher,
13    },
14};
15
16#[tokio::main]
17async fn main() -> Result<(), Box<dyn std::error::Error>> {
18    let 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(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    basin
52        .create_stream(CreateStreamInput::new("user-actions".parse()?))
53        .await?;
54
55    // Get configuration
56    let config = basin.get_stream_config("user-actions".parse()?).await?;
57
58    // Delete
59    basin
60        .delete_stream(DeleteStreamInput::new("user-actions".parse()?))
61        .await?;
62    // ANCHOR_END: stream-operations
63    println!("Streams: {:?}, config: {:?}", streams, config);
64
65    // ANCHOR: access-token-basic
66    // List tokens (returns metadata, not the secret)
67    let tokens = client.list_access_tokens(Default::default()).await?;
68
69    // Issue a token scoped to streams under "users/1234/"
70    let result = client
71        .issue_access_token(
72            IssueAccessTokenInput::new(
73                "user-1234-rw-token".parse()?,
74                AccessTokenScopeInput::from_op_group_perms(
75                    OperationGroupPermissions::new()
76                        .with_stream(ReadWritePermissions::read_write()),
77                )
78                .with_basins(BasinMatcher::Prefix("".parse()?)) // all basins
79                .with_streams(StreamMatcher::Prefix("users/1234/".parse()?)),
80            )
81            .with_expires_at("2027-01-01T00:00:00Z".parse()?),
82        )
83        .await?;
84
85    // Revoke a token
86    client
87        .revoke_access_token("user-1234-rw-token".parse()?)
88        .await?;
89    // ANCHOR_END: access-token-basic
90    println!("Tokens: {:?}, issued: {:?}", tokens, result);
91
92    // ANCHOR: access-token-restricted
93    client
94        .issue_access_token(IssueAccessTokenInput::new(
95            "restricted-token".parse()?,
96            AccessTokenScopeInput::from_op_group_perms(
97                OperationGroupPermissions::new().with_stream(ReadWritePermissions::read_only()),
98            )
99            .with_basins(BasinMatcher::Exact("production".parse()?))
100            .with_streams(StreamMatcher::Prefix("logs/".parse()?)),
101        ))
102        .await?;
103    // ANCHOR_END: access-token-restricted
104
105    // Pagination example - not executed by default
106    if false {
107        // ANCHOR: pagination
108        // Iterate through all streams with automatic pagination
109        let mut stream = basin.list_all_streams(ListAllStreamsInput::new());
110        while let Some(info) = stream.next().await {
111            let info = info?;
112            println!("{}", info.name);
113        }
114        // ANCHOR_END: pagination
115    }
116
117    Ok(())
118}
docs_account_and_basins/docs_account_and_basins.rs

docs_account_and_basins/
docs_account_and_basins.rs
