tailsurf 0.11.0

Rust SDK for tail.surf live transcript streams
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

//! Async Rust SDK and shared TSF v1 protocol types for [tail.surf](https://tail.surf).
//!
//! Use [`TsfClient`] for HTTP operations, [`TsfWriter`] for durable reconnecting writes, and
//! [`TsfReadSession`] or [`TsfSseReadSession`] for resumable reads. Stream links and transcript
//! reconstruction are available in [`stream_url`] and [`transcript`].

/// REST, SSE, and WebSocket clients, retry policy, and durable writer types.
pub mod client;
/// Stream and link IDs, link secrets, and writer identities.
pub mod ids;
/// Stream-link permission parsing and validation.
pub mod permissions;
/// TSF read options, REST models, and v1 binary WebSocket protocol types.
pub mod protocol;
/// User-provided stream titles.
pub mod stream_title;
/// Human-facing stream link parsing and construction.
pub mod stream_url;
/// Duplicate suppression and split-record transcript reconstruction.
pub mod transcript;

pub use client::{
    AppendAck, AppendReceipt, AppendTicket, IdempotencyKey, IntoRecordData, InvalidIdempotencyKey,
    ListLinksOptions, MAX_WRITER_UNACKED_PAYLOAD_BYTES, MAX_WRITER_UNACKED_RECORDS, RetryPolicy,
    TsfClient, TsfClientConfig, TsfClientError, TsfReadSession, TsfSseReadSession, TsfWriteSession,
    TsfWriter, TsfWriterConfig, WritePermit, default_api_origin,
};
pub use ids::{
    ClientWriterId, LinkId, LinkIdError, LinkSecret, LinkSecretError, MAX_LINK_ID_LEN, StreamId,
    WriterId,
};
pub use permissions::{LinkPermissions, PermissionsError};
pub use protocol::{
    read::{ReadOptions, ReadStart, ReadStop},
    rest::StreamMetadata,
    ws::frame::{AppendRecord, CaughtUpPosition, OwnedReadRecord, ReadBatch, ReadRecord},
};
pub use stream_title::{MAX_STREAM_TITLE_CODE_POINTS, StreamTitle, StreamTitleError};