Struct ListStreamsInput 

#[non_exhaustive]
pub struct ListStreamsInput {
    pub prefix: StreamNamePrefix,
    pub start_after: StreamNameStartAfter,
    pub limit: Option<usize>,
}

Input for list_streams operation.

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.

prefix: StreamNamePrefix

Filter streams whose names begin with this value.

Defaults to "".

start_after: StreamNameStartAfter

Filter streams whose names are lexicographically greater than this value.

Note: It must be greater than or equal to prefix.

Defaults to "".

limit: Option<usize>

Number of streams to return in a page. Will be clamped to a maximum of 1000.

Defaults to 1000.

Implementations

impl ListStreamsInput

pub fn new() -> Self

Create a new ListStreamsInput with default values.

Examples found in repository

examples/list_streams.rs (line 17)

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 s2 = S2::new(S2Config::new(access_token))?;
    let basin = s2.basin(basin_name);

    let input = ListStreamsInput::new().with_prefix("my-".parse()?);
    let page = basin.list_streams(input).await?;
    println!("{page:#?}");

    Ok(())
}

pub fn with_prefix(self, prefix: StreamNamePrefix) -> Self

Set the prefix used to filter streams whose names begin with this value.

Examples found in repository

examples/list_streams.rs (line 17)

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 s2 = S2::new(S2Config::new(access_token))?;
    let basin = s2.basin(basin_name);

    let input = ListStreamsInput::new().with_prefix("my-".parse()?);
    let page = basin.list_streams(input).await?;
    println!("{page:#?}");

    Ok(())
}

pub fn with_start_after(self, start_after: StreamNameStartAfter) -> Self

Set the value used to filter streams whose names are lexicographically greater than this value.

pub fn with_limit(self, limit: usize) -> Self

Set the limit on number of streams to return in a page.

Trait Implementations

impl Clone for ListStreamsInput

fn clone(&self) -> ListStreamsInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListStreamsInput

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

Formats the value using the given formatter.

impl Default for ListStreamsInput

fn default() -> ListStreamsInput

Returns the “default value” for a type.

impl From<ListStreamsInput> for ListStreamsRequest

fn from(value: ListStreamsInput) -> Self

Converts to this type from the input type.