Struct Response

pub struct Response {
    pub kind: ResponseKind,
    pub include: Vec<ResponseItem>,
}

Represents a response—in other words, the parameters for outputs.

This type does not compile as it has ‘no moving parts’—it is simply information that is passed along to the scanning system to guide it as it generates outputs.

This type is parallel, but different, from the Output type. You can think of a Response as the parameters for creating Outputs; not as the outputs themselves.

Fields

kind: ResponseKind

Represents the kind of the response, which corresponds to the possible types of Outputs: Full and Partial.

For more information about Full and Partial responses, see the documentation for ResponseKind and Output.

include: Vec<ResponseItem>

Represents the type of information that should be included in the Output.

For more information about response items, see the documentation for ResponseItem and OutputItem.

Trait Implementations

impl Clone for Response

fn clone(&self) -> Response

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Response

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Response

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Response

fn eq(&self, other: &Response) -> 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 Serialize for Response

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Validatable for Response

fn validate(&self) -> Option<Vec<Issue>>

Validates the Response and ensures that no invalid parameters are present.

More specifically, this function ensures that Excerpt and Url, which are not reducable, are not present in include.

impl StructuralPartialEq for Response