https://github.com/maxleiko/bsc

Yet another tiny beanstalkd CLI
https://github.com/maxleiko/bsc

Last synced: 7 days ago
JSON representation

Yet another tiny beanstalkd CLI

• Host: GitHub
• URL: https://github.com/maxleiko/bsc
• Owner: maxleiko
• Created: 2020-08-24T14:37:26.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-02-22T04:12:16.000Z (9 months ago)
• Last Synced: 2024-04-21T06:17:37.238Z (7 months ago)
• Language: Rust
• Size: 105 KB
• Stars: 1
• Watchers: 3
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# bsc

A complete [beanstalkd](https://beanstalkd.github.io/) client library and CLI.

The [`bsc`](/crates/lib) crate implements every commands defined in [protocol.txt](https://raw.githubusercontent.com/beanstalkd/beanstalkd/master/doc/protocol.txt), while [`bsc-cli`](/crates/cli) leverages [clap](https://docs.rs/clap/latest/clap/) to provide a user-friendly command-line interface (CLI).

[Docs](https://docs.rs/bsc/latest/bsc/struct.Beanstalk.html)

## Example

```toml

[dependencies]

bsc = { version = "0.2.0" }

```

Then, on your main.rs:

```rs

use bsc::{Beanstalk, PutResponse, ReserveResponse};

fn main() {

    let mut bsc = Beanstalk::connect("172.21.0.2:11300").unwrap();

    let res = bsc

        .put(

            0,

            Duration::from_secs(0),

            Duration::from_secs(15),

            b"hello beanstalkd",

        )

        .unwrap();

    if let PutResponse::Inserted(id) = res {

        println!("New job inserted successfully: {id}");

        let res = bsc.reserve(None).unwrap();

        if let ReserveResponse::Reserved { id, data } = res {

            println!("id   = {id}");

            println!("data = {}", std::str::from_utf8(&data).unwrap());

        }

        bsc.delete(id).unwrap();

    }

}

```

Considering your Beanstalkd instance if available at `172.21.0.2:11300` and has already 41 jobs in queue, you should see:

```text

New job inserted successfully: 42

id   = 42

data = hello beanstalkd

```

### CLI Example

The same example as the [above](#example), but using the `bsc` CLI.

First, lets set the Beanstalkd endpoint once and for all, so that we don't have to `-a 172.21.0.2:11300` for each command:

```sh

export BEANSTALKD="172.21.0.2:11300"

```

Then, put:

```sh

echo -n "hello beanstalkd" | bsc put --ttr 15

```

```text

Inserted(42)

```

Then, reserve:

```sh

bsc reserve

```

```json

{

    "id": 42,

    "data": "hello beanstalkd"

}

```

> Optionally, you can specify `-d` to the command, to only print the data of the job:

> ```sh

> bsc reserve -d

> ```

>

> ```text

> hello beanstalkd

> ```

Then, delete:

```sh

bsc delete 42

```

```text

Deleted

```

## TODO/Limitations

 - TESTS§

 - consider return exit != 0 when not happy path