Struct skytable::Pipeline

pub struct Pipeline { /* private fields */ }

Pipeline

A pipeline is a way of queing up multiple queries, sending them to the server at once instead of sending them individually, avoiding round-trip-times while also simplifying usage in several places. Responses are returned in the order they are sent.

Example with the sync API

use skytable::{query, Pipeline, Element, RespCode};
use skytable::sync::Connection;

let mut con = Connection::new("127.0.0.1", 2003).unwrap();
let pipe = Pipeline::new()
    .append(query!("set", "x", "100"))
    .append(query!("heya", "echo me!"));

let ret = con.run_pipeline(pipe).unwrap();
assert_eq!(
    ret,
    vec![
        Element::RespCode(RespCode::Okay),
        Element::String("echo me!".to_owned())
    ]
);

Example with the async API

use skytable::{query, Pipeline, Element, RespCode};
use skytable::aio::Connection;

async fn run() {
    let mut con = Connection::new("127.0.0.1", 2003).await.unwrap();
    let pipe = Pipeline::new()
        .append(query!("set", "x", "100"))
        .append(query!("heya", "echo me!"));

    let ret = con.run_pipeline(pipe).await.unwrap();
    assert_eq!(
        ret,
        vec![
            Element::RespCode(RespCode::Okay),
            Element::String("echo me!".to_owned())
        ]
    );
}

Implementations

impl Pipeline

pub fn new() -> Self

Initializes a new empty pipeline

pub fn append(self, query: Query) -> Self

Append a query (builder pattern)

pub fn push(&mut self, query: Query)

Append a query by taking reference

pub fn len(&self) -> usize

Returns the number of queries in the pipeline

pub fn is_empty(&self) -> bool

Checks if the pipeline is empty or not

pub fn into_raw_query(self) -> Vec<u8>

Available on crate feature dbg only.

Returns the query packet representation of this pipeline

Panics

This function will panic if the query is empty

Trait Implementations

impl Default for Pipeline

fn default() -> Self

Returns the “default value” for a type.