oharness-core 0.1.0

Core types, event schema, and context-plumbing traits for open-harness
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

//! Task and Attachment types (ยง4.3).

use crate::MetadataMap;
use serde::{Deserialize, Serialize};
use std::path::PathBuf;
use url::Url;

/// Pure data description of a task. No behaviour, no closures. Success predicates
/// live in `TaskEvaluator`.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[cfg_attr(feature = "schemars-export", derive(schemars::JsonSchema))]
pub struct Task {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,

    pub instruction: String,

    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub attachments: Vec<Attachment>,

    /// Reverse-DNS-namespaced keys. Unknown keys round-trip.
    #[serde(default, skip_serializing_if = "MetadataMap::is_empty")]
    pub metadata: MetadataMap,
}

impl Task {
    pub fn new(instruction: impl Into<String>) -> Self {
        Self {
            id: None,
            instruction: instruction.into(),
            attachments: Vec::new(),
            metadata: MetadataMap::new(),
        }
    }

    pub fn with_id(mut self, id: impl Into<String>) -> Self {
        self.id = Some(id.into());
        self
    }

    pub fn with_attachment(mut self, a: Attachment) -> Self {
        self.attachments.push(a);
        self
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[cfg_attr(feature = "schemars-export", derive(schemars::JsonSchema))]
#[serde(tag = "kind", rename_all = "snake_case")]
pub enum Attachment {
    Text {
        name: String,
        content: String,
    },
    File {
        name: String,
        #[cfg_attr(feature = "schemars-export", schemars(with = "String"))]
        path: PathBuf,
    },
    Inline {
        name: String,
        mime: String,
        bytes: Vec<u8>,
    },
    Url {
        #[cfg_attr(feature = "schemars-export", schemars(with = "String"))]
        url: Url,
        mime_hint: Option<String>,
    },
}