rsvici

Crates.iorsvici
lib.rsrsvici
version0.1.1
sourcesrc
created_at2022-04-03 14:37:07.67374
updated_at2022-04-10 08:47:09.791575
descriptionA client library for the VICI protocol
homepage
repositoryhttps://github.com/chitoku-k/rsvici
max_upload_size
id561317
size54,262
Chitoku (chitoku-k)

documentation

https://docs.rs/rsvici/latest/rsvici/

README

rsvici

The rsvici is a client library to configure, control, and monitor the IKE daemon charon using the VICI protocol. All the features are implemented on top of the Tokio runtime to asynchronously interact with charon.

Dependency

[dependencies]
rsvici = "0.1"

Basic Usage

  1. Refer to Client-initiated commands and Server-issued events.
  2. Define structs for the request and response.
  3. Connect to the IKE daemon either over a Unix socket or a TCP connection.
use std::error::Error;

use serde::Deserialize;

#[derive(Debug, Deserialize)]
struct Version {
    daemon: String,
    version: String,
    sysname: String,
    release: String,
    machine: String,
}

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error>> {
    let mut client = rsvici::unix::connect("/run/charon.vici").await?;

    let version: Version = client.request("version", ()).await?;
    println!("Version: {:#?}", version);

    Ok(())
}

Hints on serializing/deserializing

The serialization/deserialization implementation has certain behaviors specific to the VICI protocol:

  • bool values are serialized to or deserialized from "yes" or "no".
  • Sections with zero-based index are serialized to or deserialized from Vec<T>.
Commit count: 6

cargo fmt