Struct Report

pub struct Report {
    pub measures: Option<Measures>,
    pub units: Vec<ReportUnit>,
    pub version: u32,
    pub categories: Vec<ReportCategory>,
}

Project progress report

Fields

measures: Option<Measures>

Overall progress info

units: Vec<ReportUnit>

Units within this report

version: u32

Report version

categories: Vec<ReportCategory>

Progress categories

Implementations

impl Report

pub fn parse(data: &[u8]) -> Result<Self>

Attempts to parse the report as binary protobuf or JSON.

pub fn migrate(&mut self) -> Result<()>

Migrates the report to the latest version. Fails if the report version is newer than supported.

pub fn calculate_progress_categories(&mut self)

Calculate progress categories based on unit metadata.

pub fn split(self) -> Vec<(String, Report)>

Split the report into multiple reports based on progress categories. Assumes progress categories are in the format version, version.category. This is a hack for projects that generate all versions in a single report.

Trait Implementations

impl Clone for Report

fn clone(&self) -> Report

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Report

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

Formats the value using the given formatter.

impl Default for Report

fn default() -> Self

Returns the “default value” for a type.

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 Message for Report

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 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