Struct redis_protocol::resp3::types::StreamedFrame

pub struct StreamedFrame {
    pub attributes: Option<Attributes>,
    pub kind: FrameKind,
    // some fields omitted
}

A helper struct for reading and managing streaming data types.

use redis_protocol::resp3::decode::streaming::decode;

fn main() {
  let parts = vec!["*?\r\n", ":1\r\n", ":2\r\n:3\r\n", ".\r\n"];

  let (frame, _) = decode(parts[0].as_bytes()).unwrap().unwrap();
  assert!(frame.is_streaming());
  let mut streaming = frame.into_streaming_frame().unwrap();
  println!("Reading streaming {:?}", streaming.kind);

  let (frame, _) = decode(parts[1].as_bytes()).unwrap().unwrap();
  assert!(frame.is_complete());
  // add frames to the buffer until we reach the terminating byte sequence
  streaming.add_frame(frame.into_complete_frame().unwrap());

  let (frame, _) = decode(parts[2].as_bytes()).unwrap().unwrap();
  assert!(frame.is_complete());
  streaming.add_frame(frame.into_complete_frame().unwrap());

  let (frame, _) = decode(parts[3].as_bytes()).unwrap().unwrap();
  assert!(frame.is_complete());
  streaming.add_frame(frame.into_complete_frame().unwrap());

  assert!(streaming.is_finished());
  // convert the buffer into one frame
  let result = streaming.into_frame().unwrap();

  // Frame::Array { data: [1, 2, 3], attributes: None }
  println!("{:?}", result);
}

Fields

attributes: Option<Attributes>

Any leading attributes before the stream starts.

kind: FrameKind

The data type being streamed.

Implementations

impl StreamedFrame

pub fn new(kind: FrameKind) -> Self

Create a new StreamedFrame from the first section of data in a streaming response.

pub fn into_frame(&mut self) -> Result<Frame, RedisProtocolError>

Convert the internal buffer into one frame matching self.kind, clearing the internal buffer.

pub fn add_frame(&mut self, data: Frame)

Add a frame to the internal buffer.

pub fn is_finished(&self) -> bool

Whether or not the last frame represents the terminating sequence at the end of a frame stream.

Trait Implementations

impl Debug for StreamedFrame

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

Formats the value using the given formatter.

impl PartialEq<StreamedFrame> for StreamedFrame

fn eq(&self, other: &StreamedFrame) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &StreamedFrame) -> bool

This method tests for !=.

impl Eq for StreamedFrame

impl StructuralEq for StreamedFrame

impl StructuralPartialEq for StreamedFrame