Rust网络通信工具库zenoh-util的使用

⚠️ 警告 ⚠️
这个crate是为Zenoh内部使用而设计的。不保证在任何版本中API保持不变，包括补丁更新。强烈建议仅依赖zenoh和zenoh-ext crates，并使用它们的公共API。

安装

在项目目录中运行以下Cargo命令：

cargo add zenoh-util

或者在Cargo.toml中添加：

zenoh-util = "1.5.0"

元数据

• 版本: 1.5.0
• 许可证: EPL-2.0 OR Apache-2.0
• 大小: 26.1 KiB
• 分类: 网络编程

示例代码

以下是一个使用zenoh-util进行基本数据序列化和协议处理的示例：

use zenoh_util::core::ZResult;
use zenoh_util::properties::Properties;

fn main() -> ZResult<()> {
    // 创建一个Properties对象用于存储键值对
    let mut props = Properties::new();
    
    // 添加一些属性
    props.insert("key1".to_string(), "value1".to_string());
    props.insert("key2".to_string(), "value2".to_string());
    
    // 序列化为字节
    let bytes = props.encode()?;
    println!("Serialized properties: {:?}", bytes);
    
    // 从字节反序列化
    let decoded_props = Properties::decode(&bytes)?;
    println!("Deserialized properties: {:?}", decoded_props);
    
    Ok(())
}

高级示例

use zenoh_util::core::{ZResult, zerror};
use zenoh_util::properties::Properties;
use std::collections::HashMap;

// 自定义配置结构体
#[derive(Debug)]
struct MyConfig {
    timeout: u64,
    retries: u32,
    endpoints: Vec<String>,
}

impl MyConfig {
    // 从Properties转换为MyConfig
    fn from_properties(props: &Properties) -> ZResult<Self> {
        let timeout = props.get("timeout")
            .ok_or_else(|| zerror!("Missing 'timeout' config"))?
            .parse()
            .map_err(|_| zerror!("Invalid 'timeout' value"))?;
            
        let retries = props.get("retries")
            .map(|v| v.parse().unwrap_or(3))
            .unwrap_or(3);
            
        let endpoints = props.get("endpoints")
            .map(|s| s.split(',').map(|e| e.trim().to_string()).collect())
            .unwrap_or_default();
            
        Ok(Self { timeout, retries, endpoints })
    }
}

fn main() -> ZResult<()> {
    let mut props = Properties::new();
    props.insert("timeout".to_string(), "5000".to_string());
    props.insert("endpoints".to_string(), "127.0.0.1:7447,127.0.0.1:7448".to_string());
    
    let config = MyConfig::from_properties(&props)?;
    println!("Parsed config: {:?}", config);
    
    Ok(())
}

完整示例代码

use zenoh_util::core::{ZResult, zerror};
use zenoh_util::properties::Properties;
use std::collections::HashMap;

// 自定义配置结构体
#[derive(Debug)]
struct AppConfig {
    // 服务器监听端口
    port: u16,
    // 最大连接数
    max_connections: usize,
    // 启用TLS
    enable_tls: bool,
    // 白名单IP
    whitelist: Vec<String>,
}

impl AppConfig {
    // 从Properties创建AppConfig
    fn from_properties(props: &Properties) -> ZResult<Self> {
        // 解析端口号，必须存在且有效
        let port = props.get("port")
            .ok_or_else(|| zerror!("Missing 'port' config"))?
            .parse()
            .map_err(|_| zerror!("Invalid 'port' value"))?;
            
        // 解析最大连接数，可选，默认为100
        let max_connections = props.get("max_connections")
            .map(|v| v.parse().unwrap_or(100))
            .unwrap_or(100);
            
        // 解析是否启用TLS，可选，默认为false
        let enable_tls = props.get("enable_tls")
            .map(|v| v.parse().unwrap_or(false))
            .unwrap_or(false);
            
        // 解析白名单IP，逗号分隔，可选
        let whitelist = props.get("whitelist")
            .map(|s| s.split(',').map(|e| e.trim().to_string()).collect())
            .unwrap_or_default();
            
        Ok(Self {
            port,
            max_connections,
            enable_tls,
            whitelist
        })
    }
}

fn main() -> ZResult<()> {
    // 创建并初始化配置属性
    let mut props = Properties::new();
    props.insert("port".to_string(), "8080".to_string());
    props.insert("max_connections".to_string(), "500".to_string());
    props.insert("enable_tls".to_string(), "true".to_string());
    props.insert("whitelist".to_string(), "192.168.1.1, 192.168.1.2".to_string());
    
    // 将属性转换为结构化配置
    let config = AppConfig::from_properties(&props)?;
    println!("Application configuration: {:?}", config);
    
    // 序列化配置
    let serialized = props.encode()?;
    println!("Serialized configuration: {:?}", serialized);
    
    // 模拟网络传输后反序列化
    let deserialized = Properties::decode(&serialized)?;
    println!("Deserialized properties: {:?}", deserialized);
    
    Ok(())
}

注意事项

1. 这个crate主要是为Zenoh内部使用设计的，API可能会在不通知的情况下变更
2. 建议优先使用zenoh和zenoh-ext crates提供的公共API
3. 在生产环境中使用时需要谨慎，确保版本兼容性