Struct ClientBuilder 

pub struct ClientBuilder<Protocol = Unspecified, Mode = Unspecified> { /* private fields */ }

Type-state builder for OpenIGTLink clients

Uses compile-time type checking to ensure only valid client configurations can be constructed.

Type Parameters

• Protocol - Protocol state (Unspecified, TcpConfigured, UdpConfigured)
• Mode - Mode state (Unspecified, SyncMode, AsyncMode)

Examples

use openigtlink_rust::io::builder::ClientBuilder;

let client = ClientBuilder::new()
    .tcp("127.0.0.1:18944")
    .sync()
    .build()?;

Implementations

impl ClientBuilder<Unspecified, Unspecified>

pub fn new() -> Self

Create a new client builder

This is the starting point for building any OpenIGTLink client.

Examples

use openigtlink_rust::io::builder::ClientBuilder;

let builder = ClientBuilder::new();

impl ClientBuilder<Unspecified, Unspecified>

pub fn tcp( self, addr: impl Into<String>, ) -> ClientBuilder<TcpConfigured, Unspecified>

Select TCP protocol

Arguments

• addr - Server address (e.g., “127.0.0.1:18944”)

Examples

use openigtlink_rust::io::builder::ClientBuilder;

let builder = ClientBuilder::new()
    .tcp("127.0.0.1:18944");

pub fn udp( self, addr: impl Into<String>, ) -> ClientBuilder<UdpConfigured, SyncMode>

Select UDP protocol

Note: UDP automatically sets mode to SyncMode as UDP only supports synchronous operation.

Arguments

• addr - Server address (e.g., “127.0.0.1:18944”)

Examples

use openigtlink_rust::io::builder::ClientBuilder;

let builder = ClientBuilder::new()
    .udp("127.0.0.1:18944");

impl ClientBuilder<TcpConfigured, Unspecified>

pub fn sync(self) -> ClientBuilder<TcpConfigured, SyncMode>

Select synchronous (blocking) mode

Examples

use openigtlink_rust::io::builder::ClientBuilder;

let builder = ClientBuilder::new()
    .tcp("127.0.0.1:18944")
    .sync();

pub fn async_mode(self) -> ClientBuilder<TcpConfigured, AsyncMode>

Select asynchronous (non-blocking) mode

Examples

use openigtlink_rust::io::builder::ClientBuilder;

let builder = ClientBuilder::new()
    .tcp("127.0.0.1:18944")
    .async_mode();

impl ClientBuilder<TcpConfigured, SyncMode>

pub fn build(self) -> Result<SyncIgtlClient>

Build a synchronous TCP client

Errors

Returns error if connection fails

Examples

use openigtlink_rust::io::builder::ClientBuilder;

let client = ClientBuilder::new()
    .tcp("127.0.0.1:18944")
    .sync()
    .build()?;

impl ClientBuilder<TcpConfigured, AsyncMode>

pub fn with_tls(self, config: Arc<ClientConfig>) -> Self

Configure TLS encryption

Arguments

• config - TLS client configuration

Examples

use openigtlink_rust::io::builder::ClientBuilder;
use std::sync::Arc;

let tls_config = rustls::ClientConfig::builder()
    .with_root_certificates(rustls::RootCertStore::empty())
    .with_no_client_auth();

let client = ClientBuilder::new()
    .tcp("127.0.0.1:18944")
    .async_mode()
    .with_tls(Arc::new(tls_config))
    .build()
    .await?;

pub fn with_reconnect(self, config: ReconnectConfig) -> Self

Configure automatic reconnection

Arguments

• config - Reconnection strategy configuration

Examples

use openigtlink_rust::io::builder::ClientBuilder;
use openigtlink_rust::io::reconnect::ReconnectConfig;

let client = ClientBuilder::new()
    .tcp("127.0.0.1:18944")
    .async_mode()
    .with_reconnect(ReconnectConfig::default())
    .build()
    .await?;

pub async fn build(self) -> Result<AsyncIgtlClient>

Build an asynchronous TCP client

Creates the appropriate client variant based on configured options:

• No options: Plain async TCP client
• TLS only: TLS-encrypted async client
• Reconnect only: Auto-reconnecting async client
• TLS + Reconnect: TLS-encrypted auto-reconnecting client

Errors

Returns error if connection fails

Examples

use openigtlink_rust::io::builder::ClientBuilder;

// Plain async client
let client = ClientBuilder::new()
    .tcp("127.0.0.1:18944")
    .async_mode()
    .build()
    .await?;

impl<Protocol, Mode> ClientBuilder<Protocol, Mode>

pub fn verify_crc(self, verify: bool) -> Self

Enable or disable CRC verification for received messages

Default: true (CRC verification enabled)

Arguments

• verify - true to enable CRC verification, false to disable

Examples

use openigtlink_rust::io::builder::ClientBuilder;

let builder = ClientBuilder::new()
    .tcp("127.0.0.1:18944")
    .sync()
    .verify_crc(false);

impl ClientBuilder<UdpConfigured, SyncMode>

pub fn build(self) -> Result<UdpClient>

Build a UDP client

UDP clients use a connectionless protocol and require specifying the target address for each send operation using send_to().

Errors

Returns error if binding to local address fails

Examples

use openigtlink_rust::io::builder::ClientBuilder;
use openigtlink_rust::protocol::types::TransformMessage;
use openigtlink_rust::protocol::message::IgtlMessage;

let client = ClientBuilder::new()
    .udp("0.0.0.0:0")
    .build()?;

let transform = TransformMessage::identity();
let msg = IgtlMessage::new(transform, "Device")?;
client.send_to(&msg, "127.0.0.1:18944")?;

Trait Implementations

impl Default for ClientBuilder<Unspecified, Unspecified>

fn default() -> Self

Returns the “default value” for a type.