Struct jupiter::request::Request

pub struct Request { /* private fields */ }

Represents a parsed RESP request.

Note that we treat the 1st parameter as “command” and re-number all other parameters accordingly. Therefore “SET x y” will have “SET” as command, “x” as first parameter (index: 0) and “y” as second (index: 1).

Implementations

impl Request

pub fn parse(data: &BytesMut) -> Result<Option<Request>>

Tries to parse a RESP request from the given byte buffer.

If malformed data is detected, we return an Err. Otherwise we either return an empty optional, in case only a partial request is present or otherwise a full request which has then the form Ok(Some(Request)).

Examples

Parsing a simple request:

let mut bytes = BytesMut::from("*3\r\n$3\r\nSET\r\n$1\r\nx\r\n$1\r\ny\r\n");
let result = Request::parse(&mut bytes).unwrap().unwrap();

assert_eq!(result.command(), "SET");
assert_eq!(result.parameter_count(), 2);
assert_eq!(result.str_parameter(0).unwrap(), "x");
assert_eq!(result.str_parameter(1).unwrap(), "y");
assert_eq!(result.str_parameter(2).is_err(), true);

pub fn example(data: Vec<&str>) -> Request

Provides a helper function to create an example request in test environments.

Example

let request = Request::example(vec!("PING"));
assert_eq!(request.command(), "PING");

pub fn command(&self) -> &str

Returns the command in the request (this is the first parameter).

pub fn parameter_count(&self) -> usize

Returns the number of parameters (not counting the command itself).

pub fn parameter(&self, index: usize) -> Result<Bytes>

Returns the n-th parameter (not including the command).

Returns an Err if the requested index is outside of the range of detected parameters.

pub fn str_parameter(&self, index: usize) -> Result<&str>

Returns the n-th parameter as UTF-8 string.

Returns an Err if either the requested index is out of range or if the parameter data isn’t a valid UTF-8 sequence.

pub fn int_parameter(&self, index: usize) -> Result<i32>

Returns the n-th parameter as integer.

Returns an Err if either the requested index is out of range or if the parameter data isn’t a valid integer number.

pub fn len(&self) -> usize

Returns the total length on bytes for this request.

pub fn is_empty(&self) -> bool

Determines if the request is completely empty.