Struct auditor::domain::RecordUpdate

pub struct RecordUpdate {
    pub record_id: ValidName,
    pub meta: Option<ValidMeta>,
    pub components: Vec<Component>,
    pub start_time: Option<DateTime<Utc>>,
    pub stop_time: DateTime<Utc>,
}

RecordUpdate represents a single accountable unit that is used to set the stop_time of a Record.

Initially, records are added to Auditor by pushing a RecordAdd, where the stop_time field is optional. To later set the stop_time of the record, push a RecordUpdate with the same record_id to auditor.

Use the constructor to build a new record.

Note

All strings must not include the characters /()"<>\{}.

When created using the constructor, the record is already valid in terms of all checks that Auditor performs when receiving it.

Currently, only the stop_time can be updated. Setting other fields such as meta or components has no effect.

Examples

Create a valid record

use chrono::{DateTime, TimeZone, Utc};

let stop_time: DateTime<Utc> = Utc.with_ymd_and_hms(2023, 1, 1, 12, 0, 0).unwrap();
let record = RecordUpdate::new("123456", HashMap::new(), Vec::new(), stop_time)?;

Create a record with an invalid ID:

let record = RecordUpdate::new("123/456", HashMap::new(), Vec::new(), stop_time);
assert!(record.is_err());

Fields

record_id: ValidName

Unique identifier of the record.

meta: Option<ValidMeta>

Meta information, a collection of key value pairs in the form of String -> Vec<String>.

components: Vec<Component>

List of components that are accounted for.

start_time: Option<DateTime<Utc>>

Start time of the record.

stop_time: DateTime<Utc>

Stop time of the record.

Implementations

impl RecordUpdate

pub fn new<T: AsRef<str>>( record_id: T, meta: HashMap<T, Vec<T>>, components: Vec<Component>, stop_time: DateTime<Utc> ) -> Result<Self, Error>

Constructor.

Errors

• anyhow::Error - If there was an invalid character (/()"<>\{}) in the record_id or the meta information.

Trait Implementations

impl Clone for RecordUpdate

fn clone(&self) -> RecordUpdate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RecordUpdate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RecordUpdate

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RecordUpdate

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Record> for RecordUpdate

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.