Struct Clasp 

pub struct Clasp { /* private fields */ }

A Clasp client

Implementations

impl Clasp

pub fn new( url: &str, name: String, features: Vec<String>, token: Option<String>, reconnect: bool, reconnect_interval_ms: u64, ) -> Self

Create a new client (use builder for more options)

pub fn builder(url: &str) -> ClaspBuilder

Create a builder

pub async fn connect_to(url: &str) -> Result<Self>

Connect to server (convenience method)

pub fn start_reconnect_loop(self: &Arc<Self>)

Start the reconnect loop (call after initial connect)

pub fn is_connected(&self) -> bool

Check if connected

pub fn session_id(&self) -> Option<String>

Get session ID

pub fn time(&self) -> u64

Get current server time (microseconds)

pub async fn subscribe<F>(&self, pattern: &str, callback: F) -> Result<u32>

where F: Fn(Value, &str) + Send + Sync + 'static,

Subscribe to an address pattern

pub async fn on<F>(&self, pattern: &str, callback: F) -> Result<u32>

where F: Fn(Value, &str) + Send + Sync + 'static,

Shorthand for subscribe

pub async fn unsubscribe(&self, id: u32) -> Result<()>

Unsubscribe

pub async fn set(&self, address: &str, value: impl Into<Value>) -> Result<()>

Set a parameter value

pub async fn set_locked( &self, address: &str, value: impl Into<Value>, ) -> Result<()>

Set with lock

pub async fn set_unlocked( &self, address: &str, value: impl Into<Value>, ) -> Result<()>

Set and unlock (release a previously held lock)

pub async fn get(&self, address: &str) -> Result<Value>

Get current value (cached or request)

pub async fn emit(&self, address: &str, payload: impl Into<Value>) -> Result<()>

Emit an event

pub async fn stream(&self, address: &str, value: impl Into<Value>) -> Result<()>

Send stream sample

pub async fn gesture( &self, address: &str, id: u32, phase: GesturePhase, payload: impl Into<Value>, ) -> Result<()>

Send gesture input

Gestures are phased input streams for touch/pen/motion input. Each gesture has a stable ID and goes through phases:

• Start: Begin a new gesture
• Move: Update position/state (may be coalesced by router)
• End: Complete the gesture normally
• Cancel: Abort the gesture

Example

// Start a touch gesture
client.gesture("/input/touch", 1, GesturePhase::Start, json!({"x": 0.5, "y": 0.3})).await?;

// Move updates
client.gesture("/input/touch", 1, GesturePhase::Move, json!({"x": 0.6, "y": 0.4})).await?;

// End the gesture
client.gesture("/input/touch", 1, GesturePhase::End, json!({"x": 0.7, "y": 0.5})).await?;

pub async fn timeline( &self, address: &str, timeline_data: TimelineData, ) -> Result<()>

Publish timeline automation

Timelines are pre-computed automation curves with keyframes. Once published, timelines are immutable - to modify, publish a new one.

Arguments

• address - The parameter address this timeline controls
• timeline - The timeline data with keyframes

Example

use clasp_core::{TimelineData, TimelineKeyframe, EasingType, Value};

let timeline = TimelineData::new(vec![
    TimelineKeyframe { time: 0, value: Value::Float(0.0), easing: EasingType::Linear, bezier: None },
    TimelineKeyframe { time: 1_000_000, value: Value::Float(1.0), easing: EasingType::EaseOut, bezier: None },
]);

client.timeline("/lights/master/dimmer", timeline).await?;

pub async fn bundle(&self, messages: Vec<Message>) -> Result<()>

Send atomic bundle

pub async fn bundle_at(&self, messages: Vec<Message>, time: u64) -> Result<()>

Send scheduled bundle

pub fn cached(&self, address: &str) -> Option<Value>

Get cached param value

pub async fn close(&self)

Close connection. Disables auto-reconnect and closes the connection.

pub fn signals(&self) -> Vec<SignalDefinition>

Get all announced signals

pub fn query_signals(&self, pattern: &str) -> Vec<SignalDefinition>

Query signals matching a pattern

pub fn last_error(&self) -> Option<ErrorMessage>

Get the last error received from server

pub fn clear_error(&self)

Clear the last error