Struct Report

pub struct Report {
    pub report_id: Option<Uuid>,
    pub timestamp: Option<String>,
    pub generated_by: Option<String>,
    pub extra: HashMap<String, Value>,
    /* private fields */
}

Top-level element for a CTRF report. Corresponds to the spec’s “Root” object.

Fields

report_id: Option<Uuid>

timestamp: Option<String>

generated_by: Option<String>

extra: HashMap<String, Value>

Implementations

impl Report

pub fn new( report_id: Option<Uuid>, timestamp: Option<SystemTime>, generated_by: Option<String>, results: Results, ) -> Self

Creates an instance of a CTRF report

pub fn from_slice(s: &[u8]) -> Result<Self>

Deserialize a Report instance from bytes of JSON text

pub fn from_value(v: Value) -> Result<Self>

Interpret a serde_json::Value as a Report instance

pub fn from_reader(r: impl Read) -> Result<Self>

Deserialize a Report instance from an I/O stream of JSON text

pub fn results(&self) -> &Results

Borrows the contained Results

pub fn to_string(&self) -> Result<String>

Outputs the report as a String of JSON

pub fn to_string_pretty(&self) -> Result<String>

Outputs the report as a pretty-printed String of JSON

pub fn to_vec(&self) -> Result<Vec<u8>>

Outputs the report as a JSON byte vector

pub fn to_vec_pretty(&self) -> Result<Vec<u8>>

Outputs the report as a pretty-printed JSON byte vector

pub fn to_writer(&self, writer: impl Write) -> Result<()>

Outputs the report as JSON to the provided I/O stream

pub fn to_writer_pretty(&self, writer: impl Write) -> Result<()>

Outputs the report as pretty-printed JSON to the provided I/O stream

Trait Implementations

impl Debug for Report

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Report

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extra for Report

fn insert_extra(&mut self, key: String, value: Value) -> Option<Value>

Inserts an element into the Extra map. Returns the value that it replaced, if one was present, or None if not.

fn remove_extra(&mut self, key: &str) -> Option<Value>

Removes the value at the provided key. Returns the value if one was present, or None if not.

impl FromStr for Report

fn from_str(s: &str) -> Result<Self>

Deserialize a Report instance from a string of JSON text

type Err = Error

The associated error which can be returned from parsing.

impl PartialEq for Report

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Report