hank_types/
hank.rs

1// @generated
2// This file is @generated by prost-build.
3/// \[Internal\] Input to a send message request to Hank.
4#[derive(Clone, PartialEq, ::prost::Message)]
5pub struct SendMessageInput {
6    /// The message to send to Hank.
7    #[prost(message, optional, tag="1")]
8    pub message: ::core::option::Option<message::Message>,
9}
10/// \[Internal\] Output from a send message request to Hank.
11#[derive(Clone, PartialEq, ::prost::Message)]
12pub struct SendMessageOutput {
13    /// An error message, if there was an error.
14    #[prost(string, optional, tag="1")]
15    pub error: ::core::option::Option<::prost::alloc::string::String>,
16}
17/// \[Internal\] Input to a reaction request to Hank.
18#[derive(Clone, PartialEq, ::prost::Message)]
19pub struct ReactInput {
20    /// The reaction to send to Hank.
21    #[prost(message, optional, tag="1")]
22    pub reaction: ::core::option::Option<message::Reaction>,
23}
24/// \[Internal\] Output from a reaction request to Hank.
25#[derive(Clone, PartialEq, ::prost::Message)]
26pub struct ReactOutput {
27    /// An error message, if there was an error.
28    #[prost(string, optional, tag="1")]
29    pub error: ::core::option::Option<::prost::alloc::string::String>,
30}
31/// \[Internal\] Input to a db query request to Hank.
32#[derive(Clone, PartialEq, ::prost::Message)]
33pub struct DbQueryInput {
34    /// The prepared statement to send to Hank.
35    #[prost(message, optional, tag="1")]
36    pub prepared_statement: ::core::option::Option<database::PreparedStatement>,
37}
38/// \[Internal\] Output from a db query request to Hank.
39#[derive(Clone, PartialEq, ::prost::Message)]
40pub struct DbQueryOutput {
41    /// The database results from the query from Hank.
42    #[prost(message, optional, tag="1")]
43    pub results: ::core::option::Option<database::Results>,
44    /// An error message, if there was an error.
45    #[prost(string, optional, tag="2")]
46    pub error: ::core::option::Option<::prost::alloc::string::String>,
47}
48/// \[Internal\] Input to a cron request to Hank.
49#[derive(Clone, PartialEq, ::prost::Message)]
50pub struct CronInput {
51    /// A cronjob to send to Hank.
52    #[prost(message, optional, tag="1")]
53    pub cron_job: ::core::option::Option<cron::CronJob>,
54}
55/// \[Internal\] Output from a cron request to Hank.
56#[derive(Clone, PartialEq, ::prost::Message)]
57pub struct CronOutput {
58    /// An error message, if there was an error.
59    #[prost(string, optional, tag="1")]
60    pub error: ::core::option::Option<::prost::alloc::string::String>,
61}
62/// \[Internal\] Input to a one shot request to Hank.
63#[derive(Clone, PartialEq, ::prost::Message)]
64pub struct OneShotInput {
65    /// A one shot to send to Hank.
66    #[prost(message, optional, tag="1")]
67    pub one_shot_job: ::core::option::Option<cron::OneShotJob>,
68}
69/// \[Internal\] Output from a one shot request to Hank.
70#[derive(Clone, PartialEq, ::prost::Message)]
71pub struct OneShotOutput {
72    /// An error message, if there was an error.
73    #[prost(string, optional, tag="1")]
74    pub error: ::core::option::Option<::prost::alloc::string::String>,
75}
76/// \[Internal\] Input to a reload plugin request to Hank.
77#[derive(Clone, PartialEq, ::prost::Message)]
78pub struct ReloadPluginInput {
79    /// The plugin to reload.
80    #[prost(string, tag="1")]
81    pub plugin: ::prost::alloc::string::String,
82}
83/// \[Internal\] Output from a reload plugin request to Hank.
84#[derive(Clone, PartialEq, ::prost::Message)]
85pub struct ReloadPluginOutput {
86    /// An error message, if there was an error.
87    #[prost(string, optional, tag="1")]
88    pub error: ::core::option::Option<::prost::alloc::string::String>,
89}
90/// \[Internal\] Input to a load plugin request to Hank.
91#[derive(Clone, PartialEq, ::prost::Message)]
92pub struct LoadPluginInput {
93    /// A compiled plugin wasm file to load.
94    #[prost(oneof="load_plugin_input::Wasm", tags="1, 2, 3")]
95    pub wasm: ::core::option::Option<load_plugin_input::Wasm>,
96}
97/// Nested message and enum types in `LoadPluginInput`.
98pub mod load_plugin_input {
99    /// A compiled plugin wasm file to load.
100    #[derive(Clone, PartialEq, ::prost::Oneof)]
101    pub enum Wasm {
102        /// Get compiled plugin wasm file from a url.
103        #[prost(string, tag="1")]
104        Url(::prost::alloc::string::String),
105        /// Get compiled plugin wasm file from a path on hanks system.
106        #[prost(string, tag="2")]
107        Path(::prost::alloc::string::String),
108        /// Compiled plugin wasm file as bytes.
109        #[prost(bytes, tag="3")]
110        Bytes(::prost::alloc::vec::Vec<u8>),
111    }
112}
113/// \[Internal\] Output from a load plugin request to Hank.
114#[derive(Clone, PartialEq, ::prost::Message)]
115pub struct LoadPluginOutput {
116    /// The metadata returned by the loaded plugin.
117    #[prost(message, optional, tag="1")]
118    pub metadata: ::core::option::Option<plugin::Metadata>,
119    /// The plugins extism::Manifest, as JSON.
120    #[prost(string, tag="2")]
121    pub manifest: ::prost::alloc::string::String,
122    /// An error message, if there was an error.
123    #[prost(string, optional, tag="3")]
124    pub error: ::core::option::Option<::prost::alloc::string::String>,
125}
126/// \[Internal\] Input to a InstructionKind::ChatCommand request to Hank.
127#[derive(Clone, PartialEq, ::prost::Message)]
128pub struct ChatCommandInput {
129    /// The chat command context to send to Hank.
130    #[prost(message, optional, tag="1")]
131    pub context: ::core::option::Option<plugin::CommandContext>,
132    /// The message that the chat command originates from.
133    #[prost(message, optional, tag="2")]
134    pub message: ::core::option::Option<message::Message>,
135}
136/// \[Internal\] Output from a InstructionKind::ChatCommand request to Hank.
137#[derive(Clone, Copy, PartialEq, ::prost::Message)]
138pub struct ChatCommandOutput {
139}
140/// \[Internal\] Input to a InstructionKind::ChatMessage request to Hank.
141#[derive(Clone, PartialEq, ::prost::Message)]
142pub struct ChatMessageInput {
143    /// The chat message.
144    #[prost(message, optional, tag="1")]
145    pub message: ::core::option::Option<message::Message>,
146}
147/// \[Internal\] Output from a InstructionKind::ChatMessage request to Hank.
148#[derive(Clone, Copy, PartialEq, ::prost::Message)]
149pub struct ChatMessageOutput {
150}
151/// \[Internal\] Input to a InstructionKind::GetMetadata request to Hank.
152#[derive(Clone, Copy, PartialEq, ::prost::Message)]
153pub struct GetMetadataInput {
154}
155/// \[Internal\] Output from a InstructionKind::GetMetadata request to Hank.
156#[derive(Clone, PartialEq, ::prost::Message)]
157pub struct GetMetadataOutput {
158    /// The metadata returned by the plugin.
159    #[prost(message, optional, tag="1")]
160    pub metadata: ::core::option::Option<plugin::Metadata>,
161}
162/// \[Internal\] Input to a InstructionKind::Initialize request to Hank.
163#[derive(Clone, Copy, PartialEq, ::prost::Message)]
164pub struct InitializeInput {
165}
166/// \[Internal\] Output from a InstructionKind::Initialize request to Hank.
167#[derive(Clone, Copy, PartialEq, ::prost::Message)]
168pub struct InitializeOutput {
169}
170/// \[Internal\] Input to a InstructionKind::Install request to Hank.
171#[derive(Clone, Copy, PartialEq, ::prost::Message)]
172pub struct InstallInput {
173}
174/// \[Internal\] Output from a InstructionKind::Install request to Hank.
175#[derive(Clone, Copy, PartialEq, ::prost::Message)]
176pub struct InstallOutput {
177}
178/// \[Internal\] Input to a InstructionKind::SheduledJob request to Hank.
179#[derive(Clone, PartialEq, ::prost::Message)]
180pub struct ScheduledJobInput {
181    #[prost(oneof="scheduled_job_input::ScheduledJob", tags="1, 2")]
182    pub scheduled_job: ::core::option::Option<scheduled_job_input::ScheduledJob>,
183}
184/// Nested message and enum types in `ScheduledJobInput`.
185pub mod scheduled_job_input {
186    #[derive(Clone, PartialEq, ::prost::Oneof)]
187    pub enum ScheduledJob {
188        /// A cronjob to send to Hank.
189        #[prost(message, tag="1")]
190        CronJob(super::cron::CronJob),
191        /// A one shot to send to Hank.
192        #[prost(message, tag="2")]
193        OneShotJob(super::cron::OneShotJob),
194    }
195}
196/// \[Internal\] Output from a InstructionKind::ScheduledJob request to Hank.
197#[derive(Clone, Copy, PartialEq, ::prost::Message)]
198pub struct ScheduledJobOutput {
199}
200/// \[Internal\] Input to a InstructionKind::Shutdown request to Hank.
201#[derive(Clone, Copy, PartialEq, ::prost::Message)]
202pub struct ShutdownInput {
203}
204/// \[Internal\] Output from a InstructionKind::Shutdown request to Hank.
205#[derive(Clone, Copy, PartialEq, ::prost::Message)]
206pub struct ShutdownOutput {
207}
208/// \[Internal\] Input to a instruct plugin request to Hank.
209#[derive(Clone, PartialEq, ::prost::Message)]
210pub struct InstructPluginInput {
211    /// The the instruction to send to a Hank plugin.
212    #[prost(message, optional, tag="1")]
213    pub instruction: ::core::option::Option<plugin::Instruction>,
214}
215/// \[Internal\] Output from a instruct plugin request to Hank.
216#[derive(Clone, PartialEq, ::prost::Message)]
217pub struct InstructPluginOutput {
218    /// An error message, if there was an error.
219    #[prost(string, optional, tag="1")]
220    pub error: ::core::option::Option<::prost::alloc::string::String>,
221}
222/// \[Internal\] Input to an unload plugin request to Hank.
223#[derive(Clone, PartialEq, ::prost::Message)]
224pub struct UnloadPluginInput {
225    /// The plugin to unload.
226    #[prost(string, tag="1")]
227    pub plugin: ::prost::alloc::string::String,
228    /// Whether or not hank should clean up any plugin assets, e.g. database file.
229    /// This should be set to true if this plugin is being unloaded as a result
230    /// of an uninstall command.
231    #[prost(bool, tag="2")]
232    pub cleanup: bool,
233}
234/// \[Internal\] Output from an unload plugin request to Hank.
235#[derive(Clone, PartialEq, ::prost::Message)]
236pub struct UnloadPluginOutput {
237    /// An error message, if there was an error.
238    #[prost(string, optional, tag="1")]
239    pub error: ::core::option::Option<::prost::alloc::string::String>,
240}
241/// \[Internal\] Input to a datetime request to Hank.
242#[derive(Clone, Copy, PartialEq, ::prost::Message)]
243pub struct DatetimeInput {
244}
245/// \[Internal\] Output from a datetime request to Hank.
246#[derive(Clone, PartialEq, ::prost::Message)]
247pub struct DatetimeOutput {
248    /// Hanks local date/time in RFC 3339 format.
249    #[prost(string, tag="1")]
250    pub datetime: ::prost::alloc::string::String,
251}
252/// \[Internal\] Input to a get user request to Hank.
253#[derive(Clone, PartialEq, ::prost::Message)]
254pub struct GetUserInput {
255    /// The id of the user to look up, as a string.
256    #[prost(string, tag="1")]
257    pub id: ::prost::alloc::string::String,
258}
259/// \[Internal\] Output from a get user request to Hank.
260#[derive(Clone, PartialEq, ::prost::Message)]
261pub struct GetUserOutput {
262    /// A user object for the queried user, if a user was found.
263    #[prost(message, optional, tag="1")]
264    pub user: ::core::option::Option<user::User>,
265    /// An error message, if there was an error.
266    #[prost(string, optional, tag="2")]
267    pub error: ::core::option::Option<::prost::alloc::string::String>,
268}
269/// \[Internal\] Input to a handle chat command request to Hank.
270#[derive(Clone, PartialEq, ::prost::Message)]
271pub struct HandleChatCommandInput {
272    /// The chat command context to send to Hank.
273    #[prost(message, optional, tag="1")]
274    pub context: ::core::option::Option<plugin::CommandContext>,
275    /// The message that the chat command originates from.
276    #[prost(message, optional, tag="2")]
277    pub message: ::core::option::Option<message::Message>,
278}
279/// \[Internal\] Output from a handle chat command request to Hank.
280#[derive(Clone, Copy, PartialEq, ::prost::Message)]
281pub struct HandleChatCommandOutput {
282}
283// @@protoc_insertion_point(module)
hank_types/hank.rs

hank_types/
hank.rs
