Struct CCCCClient 

pub struct CCCCClient { /* private fields */ }

Blocking CCCC Daemon IPC v1 client.

Implementations

impl CCCCClient

pub fn discover() -> Result<Self>

Discover the currently running daemon.

Examples found in repository

examples/compat_check.rs (line 4)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = CCCCClient::discover()?;
    let requirements = CompatibilityRequirements {
        minimum_ipc_version: 1,
        operations: vec![
            "groups",
            "group_show",
            "send",
            "reply",
            "inbox_list",
            "context_get",
            "context_sync",
            "group_preamble_get",
            "terminal_history",
        ],
        ..Default::default()
    };
    let daemon = client.assert_compatible(&requirements)?;
    println!(
        "CCCC {} ({}) is compatible with IPC v{}",
        daemon.version,
        daemon.implementation.as_deref().unwrap_or("unknown"),
        daemon.ipc_v
    );
    Ok(())
}

pub fn discover_in(cccc_home: Option<&Path>) -> Result<Self>

Discover a daemon under an explicit CCCC_HOME.

pub fn new(endpoint: DaemonEndpoint) -> Self

pub fn with_timeout(self, timeout: Duration) -> Self

pub fn endpoint(&self) -> &DaemonEndpoint

pub fn call( &self, op: &str, args: Map<String, Value>, ) -> Result<Map<String, Value>>

Call any non-streaming daemon operation and return its result object.

pub fn call_raw( &self, op: &str, args: Map<String, Value>, ) -> Result<DaemonResponse>

Call an operation and retain the full response envelope.

pub fn ping(&self) -> Result<PingResult>

pub fn groups(&self) -> Result<Map<String, Value>>

pub fn group_show(&self, group_id: &str) -> Result<Map<String, Value>>

pub fn send( &self, group_id: &str, text: &str, by: &str, ) -> Result<Map<String, Value>>

pub fn reply( &self, group_id: &str, reply_to: &str, text: &str, by: &str, ) -> Result<Map<String, Value>>

pub fn inbox_list( &self, group_id: &str, actor_id: &str, limit: Option<u32>, ) -> Result<Map<String, Value>>

pub fn context_get(&self, group_id: &str) -> Result<Map<String, Value>>

pub fn context_sync( &self, group_id: &str, by: &str, operations: Vec<Value>, ) -> Result<Map<String, Value>>

pub fn assert_compatible( &self, requirements: &CompatibilityRequirements<'_>, ) -> Result<PingResult>

Validate protocol, advertised capabilities, and actual op recognition.

Examples found in repository

examples/compat_check.rs (line 20)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = CCCCClient::discover()?;
    let requirements = CompatibilityRequirements {
        minimum_ipc_version: 1,
        operations: vec![
            "groups",
            "group_show",
            "send",
            "reply",
            "inbox_list",
            "context_get",
            "context_sync",
            "group_preamble_get",
            "terminal_history",
        ],
        ..Default::default()
    };
    let daemon = client.assert_compatible(&requirements)?;
    println!(
        "CCCC {} ({}) is compatible with IPC v{}",
        daemon.version,
        daemon.implementation.as_deref().unwrap_or("unknown"),
        daemon.ipc_v
    );
    Ok(())
}

Trait Implementations

impl Clone for CCCCClient

fn clone(&self) -> CCCCClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CCCCClient

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

Formats the value using the given formatter.