pub struct StreamedFrame {
    pub attributes: Option<Attributes>,
    pub kind: FrameKind,
    /* private fields */
}
Expand description

A helper struct for reading and managing streaming data types.

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

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

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

  let (frame, _) = decode(&parts[1]).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]).unwrap().unwrap();
  assert!(frame.is_complete());
  streaming.add_frame(frame.into_complete_frame().unwrap());

  let (frame, _) = decode(&parts[3]).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], attributes: None }
  println!("{:?}", result);
}

Fields

attributes: Option<Attributes>

Any leading attributes before the stream starts.

kind: FrameKind

The data type being streamed.

Implementations

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

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

Add a frame to the internal buffer.

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

Trait Implementations

Formats the value using the given formatter. Read more

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

This method tests for !=.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.