hipcheck-common 0.5.0

Common functionality for the Hipcheck gRPC protocol
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

// SPDX-License-Identifier: Apache-2.0

/// An enumeration of errors that can occur in a Hipcheck plugin
#[derive(Debug, thiserror::Error)]
pub enum Error {
	/// An unknown error occurred, the query is in an unspecified state
	#[error("unknown error")]
	UnspecifiedQueryState,

	#[error("the query is not supported for the target")]
	QueryUnsupportedForTarget,

	/// The `PluginEngine` received a message with the unexpected status `ReplyInProgress`
	#[error("unexpected ReplyInProgress state for query")]
	UnexpectedReplyInProgress,

	/// The `PluginEngine` received a message with the unexpected status `RequestInProgress`
	#[error("unexpected RequestInProgress state for query")]
	UnexpectedRequestInProgress,

	/// The `PluginEngine` received a message with a request-type status when it expected a reply
	#[error("remote sent QuerySubmit when reply chunk expected")]
	ReceivedSubmitWhenExpectingReplyChunk,

	/// The `PluginEngine` received a message with a reply-type status when it expected a submit
	#[error("remote sent QueryReply when submit chunk expected")]
	ReceivedReplyWhenExpectingSubmitChunk,

	/// The `PluginEngine` received additional messages when it did not expect any
	#[error("received additional message for ID '{id}' after query completion")]
	MoreAfterQueryComplete { id: usize },

	#[error("invalid JSON in query key")]
	InvalidJsonInQueryKey(#[source] serde_json::Error),

	#[error("invalid JSON in query output")]
	InvalidJsonInQueryOutput(#[source] serde_json::Error),
}