Skip to main content

Parser

Struct Parser 

Source
pub struct Parser { /* private fields */ }
Expand description

Streaming RESP2 parser.

Feed data incrementally and extract frames as they become available.

§Examples

use bytes::Bytes;
use resp_rs::resp2::{Parser, Frame};

let mut parser = Parser::new();
parser.feed(Bytes::from("+HEL"));
assert!(parser.next_frame().unwrap().is_none());

parser.feed(Bytes::from("LO\r\n"));
let frame = parser.next_frame().unwrap().unwrap();
assert_eq!(frame, Frame::SimpleString(Bytes::from("HELLO")));

Implementations§

Source§

impl Parser

Source

pub fn new() -> Self

Create a new empty parser.

Source

pub fn feed(&mut self, data: Bytes)

Feed data into the parser buffer.

Source

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

Try to extract the next complete frame.

Returns Ok(None) if there isn’t enough data yet. Returns Err on protocol errors (buffer is cleared).

Source

pub fn buffered_bytes(&self) -> usize

Number of bytes currently buffered.

Source

pub fn clear(&mut self)

Clear the internal buffer.

Trait Implementations§

Source§

impl Debug for Parser

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Parser

Source§

fn default() -> Parser

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.