Struct Query 

pub struct Query {
    pub id: i32,
    pub state: i32,
    pub publisher_name: String,
    pub plugin_name: String,
    pub query_name: String,
    pub key: Vec<String>,
    pub output: Vec<String>,
    pub concern: Vec<String>,
    pub split: bool,
}

Fields

id: i32

The ID of the request, used to associate requests and replies. Odd numbers = initiated by hc. Even numbers = initiated by a plugin.

state: i32

The state of the query, indicating if this is a request or a reply, and if it’s a reply whether it’s the end of the reply.

publisher_name: String

Publisher name and plugin name, when sent from Hipcheck to a plugin to initiate a fresh query, are used by the receiving plugin to validate that the query was intended for them.

When a plugin is making a query to another plugin through Hipcheck, it’s used to indicate the destination plugin, and to indicate the plugin that is replying when Hipcheck sends back the reply.

plugin_name: String

query_name: String

The name of the query being made, so the responding plugin knows what to do with the provided data.

key: Vec<String>

The key for the query, as a JSON object. This is the data that Hipcheck’s incremental computation system will use to cache the response.

output: Vec<String>

The response for the query, as a JSON object. This will be cached by Hipcheck for future queries matching the publisher name, plugin name, query name, and key.

concern: Vec<String>

An unstructured concern raised during the query that will be raised in the final Hipcheck report.

split: bool

Used to indicate whether or not a string field present in a repeated string field was split between two messages

Implementations

impl Query

pub fn state(&self) -> QueryState

Returns the enum value of state, or the default if the field is set to an invalid enum value.

pub fn set_state(&mut self, value: QueryState)

Sets state to the provided enum value.

Trait Implementations

impl Clone for Query

fn clone(&self) -> Query

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Query

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Query

fn default() -> Self

Returns the “default value” for a type.

impl Message for Query

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Query

fn eq(&self, other: &Query) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<Query> for Query

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: PluginQuery) -> Result<Query, Self::Error>

Performs the conversion.

impl TryFrom<Query> for Query

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Query) -> Result<PluginQuery, Self::Error>

Performs the conversion.

impl StructuralPartialEq for Query