Struct FrameStream 

pub struct FrameStream { /* private fields */ }

High-level async iterator over reassembled GVSP frames.

Wraps a low-level Stream and handles packet parsing, reassembly, and optional resend requests automatically.

Example

let raw_stream = StreamBuilder::new(&mut device)
    .iface(iface)
    .build()
    .await?;
let mut frame_stream = FrameStream::new(raw_stream, None);
while let Some(frame) = frame_stream.next_frame().await? {
    println!("Frame: {}x{}", frame.width, frame.height);
}

Implementations

impl FrameStream

pub fn new(stream: Stream, time_sync: Option<TimeSync>) -> Self

Create a new frame stream from a configured Stream.

Optionally accepts a TimeSync for mapping device timestamps to host time.

pub fn set_frame_timeout(&mut self, timeout: Duration)

Set the frame assembly timeout.

If a frame is not complete within this duration, it will be dropped and assembly will move on to the next frame.

pub fn set_time_sync(&mut self, time_sync: TimeSync)

Update or set the time synchronization model for timestamp mapping.

pub fn stats_handle(&self) -> StreamStatsAccumulator

Obtain a clone of the statistics accumulator handle.

pub fn stats(&self) -> StreamStats

Snapshot the collected statistics.

pub fn params(&self) -> StreamParams

Access the negotiated stream parameters.

pub fn config(&self) -> &StreamConfig

Immutable view of the stream configuration.

pub fn socket(&self) -> Option<&UdpSocket>

Borrow the underlying UDP socket (returns None when using a custom transport).

pub async fn next_frame(&mut self) -> Result<Option<Frame>, GenicamError>

Receive the next complete frame.

This method handles packet reception, parsing, and reassembly internally. Returns Ok(Some(frame)) when a complete frame is available, or Ok(None) if the stream has ended (socket closed).