电影

一个actor/线程编排库

crates.io repo 文档

概述

• 几乎没有样板代码 - 看示例
• 与稳定编译器兼容，但需要2018版
• 除了 std 外没有外部依赖
• 基于枚举的MPSC通道通信
• 默认情况下，一个actor = 一个线程
• 默认情况下，actor只接受消息，不发送回复
  • 发送回复的解决方案现在还不是最优雅的，请参见下面的高级示例
• 网络RPC应该是可能的，但超出了此crate的范围。如果你想这样做，可以使用 input_derive 和 custom_code 来派生 Serialize 和 Deserialize。
• 两个过程宏 - 请参阅movie_derive
• actor需要在模块/crate范围内定义
• 目前错误消息不好，使用宏加手动字符串解析魔法
• 如果在（稳定的）TokenStream::to_string()中有大的破坏性变化，宏可能会中断

示例

以下示例被测试为忽略的，因为据我所知，在文档测试中无法运行过程宏。它们也在 tests 目录中，在那里它们被测试。

安装

[dependencies]
"movie" = "0.1"

简单actor

use movie::actor;

actor! { SimplestActor } // completely useless

actor! {
    SimpleActor
        input: Ping,
        on_message:
            Ping => (),
}

#[test]
fn test_simple_actor() {
    use SimpleActor::{Actor, Input};
    // Create and spawn the actor
    let actor = Actor {}.start();

    actor.send(Input::Ping);
    actor.stop(); // Will block, waiting for actor.
}

高级示例

use movie::actor;

use std::sync::mpsc::Sender;
actor! {
    StreamParsingActor
        public_visibility: true,
        docs: /// Actor that parses video from V4L2 device
              /// It's very consistent - failed every time so far.
        input:
            ChangeSource(String),
            SendState,
        // By default, Input enum does not have any trait auto-implemented.
        input_derive: Debug, PartialEq,
        // Whitespace and comments are irrelevant.
        // It's also optional to end sections (attributes) with a comma, with
        // exception of code attributes (on_stop, on_init etc.), which should
        // not end with comma, but rather either with nothing or with a semicolon.
        data:
            pub device: String,
            pub state_tx: Sender<u64>,
        on_init:
            if self.device == "admin secret device" {
                panic!("No access right for admin secret device");
            }
            let mut lines_parsed = 0; // This variable will be exposed to on_message.
                                      // This is suboptimal, but it is the simplest
                                      // way to allow for thread-local variables (`data`
                                      // is sent between threads, so it couldn't be used
                                      // e.g. for GTK references)
        on_message:
            ChangeSource(name) => {
                self.device = name;
            },
            SendState => {
                self.state_tx.send(lines_parsed).unwrap();
            }
        tick_interval: 5, // Every 5ms, default = 100
        on_tick: // on_message have priority over on_tick
            lines_parsed += 1;
        on_stop: ()
        // custom_code must end with a semicolon
        custom_code:
            pub const DEFAULT_DEVICE: &'static str = "video0";
}

#[test]
fn test_stream_parsing_actor() {
    use StreamParsingActor::{Actor, Input, DEFAULT_DEVICE};

    use std::sync::mpsc::channel;
    let (tx, rx) = channel();
    let cfg = Actor {
        device: DEFAULT_DEVICE.to_string(),
        state_tx: tx,
    };
    // Spawn the actor, let on_init run
    let actor = cfg.start(); // returns StreamParsingActor::Handle

    use std::thread::sleep;
    use std::time::Duration;
    sleep(Duration::from_millis(100));

    // We can use auto-derived traits on Input
    actor.send(dbg!(Input::SendState));
    println!("Ticked {} times in 100ms", rx.recv().unwrap()); // 20

    actor.stop();
}

扩展示例

请参阅movie_example。

actor属性

如果这些词后面跟着冒号，它们是受限关键字。

• input - 定义 Input 枚举
• input_derive - 为 Input 枚举提供 #[derive)]
• data - actor 状态变量，需要在创建actor时设置
• on_init - 在演员开始接收消息之前运行
• on_message - 定义 match 消息 逻辑
• tick_interval - 两次tick之间的时间（毫秒）。当未定义时，设置为100ms。影响消息轮询，因此不要设置得太高。
• on_tick - 每次tick时运行
• on_stop - 在演员停止接收消息之后运行
• spawner - 创建线程的函数名称（默认为 std::thread::spawn，在此处放置一个具有相似签名的函数，以便将演员作为future、M:N线程等运行）
• spawner_return_type - spawner 的返回类型（默认为 std::thread::JoinHandle<()>）
• custom_code - 要插入到生成的演员模块中的代码
• public_visibility - 如果 true，则演员模块是公开的
• docs - 在此处放置文档 - 例如 docs: /// 一个演员