Struct AppendInput 

#[non_exhaustive]
pub struct AppendInput {
    pub records: AppendRecordBatch,
    pub match_seq_num: Option<u64>,
    pub fencing_token: Option<FencingToken>,
}

Input for append operation and AppendSession::submit.

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.

records: AppendRecordBatch

Batch of records to append atomically.

match_seq_num: Option<u64>

Expected sequence number for the first record in the batch.

If unspecified, no matching is performed. If specified and mismatched, the append fails.

fencing_token: Option<FencingToken>

Fencing token to match against the stream’s current fencing token.

If unspecified, no matching is performed. If specified and mismatched, the append fails. A stream defaults to "" as its fencing token.

Implementations

impl AppendInput

pub fn new(records: AppendRecordBatch) -> Self

Create a new AppendInput with the given batch of records.

Examples found in repository

examples/explicit_trim.rs (lines 26-29)

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 stream_name: StreamName = std::env::var("S2_STREAM")
        .map_err(|_| "S2_STREAM env var not set")?
        .parse()?;

    let s2 = S2::new(S2Config::new(access_token))?;
    let stream = s2.basin(basin_name).stream(stream_name);

    let tail = stream.check_tail().await?;
    if tail.seq_num == 0 {
        println!("Empty stream");
        return Ok(());
    }

    let input = AppendInput::new(AppendRecordBatch::try_from_iter([CommandRecord::trim(
        tail.seq_num - 1,
    )
    .into()])?);
    stream.append(input).await?;
    println!("Trim requested");

    Ok(())
}

pub fn with_match_seq_num(self, match_seq_num: u64) -> Self

Set the expected sequence number for the first record in the batch.

pub fn with_fencing_token(self, fencing_token: FencingToken) -> Self

Set the fencing token to match against the stream’s current fencing token.

Trait Implementations

impl Clone for AppendInput

fn clone(&self) -> AppendInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AppendInput

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

Formats the value using the given formatter.

impl From<AppendInput> for AppendInput

fn from(value: AppendInput) -> Self

Converts to this type from the input type.