lumen-server 0.2.2

Embeddable render service primitives and local HTTP server for Lumen.
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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

use std::collections::HashMap;

use serde::{Deserialize, Serialize};
use serde_json::Value;

#[derive(Debug, Deserialize)]
pub struct RenderJobInput {
    #[serde(default)]
    pub job_id: Option<String>,
    #[serde(alias = "project")]
    pub composition: Value,
    #[serde(default)]
    pub media: HashMap<String, String>,
    #[serde(default)]
    #[serde(rename = "webhookUrl")]
    pub webhook_url: Option<String>,
}

#[derive(Debug, Serialize)]
pub struct RenderJobResponse {
    pub ok: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub artifact: Option<ArtifactOutput>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub metrics: Option<RenderJobMetrics>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub error: Option<RenderJobError>,
}

#[derive(Debug, Serialize)]
pub struct ArtifactOutput {
    pub download_url: String,
    pub content_type: &'static str,
    pub bytes: usize,
}

#[derive(Debug, Serialize)]
pub struct RenderJobMetrics {
    pub stage_ms: u128,
    pub render_ms: u128,
    pub total_frames: u64,
}

#[derive(Debug, Serialize)]
pub struct RenderJobError {
    pub code: String,
    pub message: String,
    pub retryable: bool,
}

#[derive(Debug, Clone, Serialize)]
pub struct ApiRenderJob {
    #[serde(rename = "costCents")]
    pub cost_cents: u32,
    #[serde(rename = "createdAt")]
    pub created_at: String,
    pub id: String,
    #[serde(rename = "inputHash")]
    pub input_hash: String,
    #[serde(rename = "organizationId")]
    pub organization_id: String,
    pub status: &'static str,
}

#[derive(Debug, Serialize)]
pub struct CreateRenderResponse {
    pub cached: bool,
    pub render: ApiRenderJob,
}

#[derive(Debug, Serialize)]
pub struct GetRenderResponse {
    pub render: ApiRenderJob,
}

#[derive(Debug, Clone, Serialize)]
pub struct RenderQueueState {
    #[serde(rename = "artifactUrl", skip_serializing_if = "Option::is_none")]
    pub artifact_url: Option<String>,
    #[serde(rename = "durationMs", skip_serializing_if = "Option::is_none")]
    pub duration_ms: Option<u128>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub error: Option<String>,
    #[serde(rename = "organizationId")]
    pub organization_id: String,
    #[serde(rename = "outputBytes", skip_serializing_if = "Option::is_none")]
    pub output_bytes: Option<usize>,
    pub progress: f32,
    #[serde(rename = "renderId")]
    pub render_id: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub resolution: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub stage: Option<&'static str>,
    pub state: &'static str,
    #[serde(rename = "updatedAt")]
    pub updated_at: String,
}

#[derive(Debug, Serialize)]
pub struct RenderProgressResponse {
    pub progress: Option<RenderQueueState>,
    pub render: ApiRenderJob,
}

#[derive(Debug, Clone, Serialize)]
pub struct RenderNotification {
    pub state: Option<RenderQueueState>,
    #[serde(rename = "type")]
    pub kind: &'static str,
}