Struct IFlowClient 

pub struct IFlowClient { /* private fields */ }

Main client for bidirectional communication with iFlow

This client handles the full lifecycle of communication with iFlow, including process management, connection handling, and message passing.

Implementations

impl IFlowClient

pub fn new(options: Option<IFlowOptions>) -> Self

Create a new iFlow client

Arguments

• options - Optional configuration for the client. If None, defaults will be used.

Returns

A new IFlowClient instance

pub async fn connect(&mut self) -> Result<()>

Connect to iFlow

Establishes a connection to iFlow, starting the process if auto_start_process is enabled. This method handles all the necessary setup for communication via stdio or WebSocket.

Returns

• Ok(()) if the connection was successful
• Err(IFlowError) if the connection failed

pub async fn send_message( &mut self, text: &str, _files: Option<Vec<&Path>>, ) -> Result<()>

Send a message to iFlow

Sends a text message to iFlow and handles the complete request-response cycle. This method initializes the connection, creates a new session, sends the prompt, and waits for completion before returning.

Arguments

• text - The text message to send to iFlow
• _files - Optional files to send (currently not implemented)

Returns

• Ok(()) if the message was sent successfully
• Err(IFlowError) if there was an error

pub async fn interrupt(&self) -> Result<()>

Interrupt the current message generation

Sends an interrupt signal to stop the current message generation. This is useful for canceling long-running requests.

Returns

• Ok(()) if the interrupt was sent successfully
• Err(IFlowError) if there was an error

pub fn messages(&self) -> MessageStream

Receive messages from iFlow

Returns a stream of messages from iFlow that can be used with async iteration.

Returns

A MessageStream that implements futures::Stream

pub async fn receive_message(&self) -> Result<Option<Message>>

Receive a single message (convenience method)

Waits for and returns the next message from iFlow.

Returns

• Ok(Some(Message)) if a message was received
• Ok(None) if the channel is closed
• Err(IFlowError) if there was an error

pub async fn disconnect(&mut self) -> Result<()>

Disconnect from iFlow

Cleans up the connection to iFlow and stops the process if it was started by this client. This method ensures proper cleanup of resources.

Returns

• Ok(()) if the disconnection was successful
• Err(IFlowError) if there was an error

Trait Implementations

impl Drop for IFlowClient

fn drop(&mut self)

Executes the destructor for this type.