Struct Statement

pub struct Statement { /* private fields */ }

Structure showing evidence of any sort of experience or event to be tracked in xAPI as a Learning Record.

A set of several Statements, each representing an event in time, might be used to track complete details about a learning experience.

Implementations

impl Statement

pub fn from_json_obj(map: Map<String, Value>) -> Result<Self, DataError>

Construct and validate a Statement from a JSON map.

pub fn builder() -> StatementBuilder

Return a Statement Builder.

pub fn id(&self) -> Option<&Uuid>

Return the id field (a UUID) if set; None otherwise. It’s assigned by the LRS if not already set by the LRP.

pub fn set_id(&mut self, id: Uuid)

Set the id field of this instance to the given value.

pub fn actor(&self) -> &Actor

Return the Actor whom the Statement is about. The Actor is either an Agent or a Group.

pub fn verb(&self) -> &Verb

Return the action taken by the actor.

pub fn is_verb_voided(&self) -> bool

Return TRUE if verb is voided; FALSE otherwise.

pub fn object(&self) -> &StatementObject

Return an Activity, an Agent, or another Statement that is the Object of this instance.

pub fn voided_target(&self) -> Option<Uuid>

Return the UUID of the (target) Statement to be voided by this one iff (a) the verb is voided, and (b) the object is a StatementRef.

Return None otherwise.

pub fn result(&self) -> Option<&XResult>

Return the XResult instance if set; None otherwise.

pub fn context(&self) -> Option<&Context>

Return the Context of this instance if set; None otherwise.

pub fn timestamp(&self) -> Option<&DateTime<Utc>>

Return the timestamp of when the events described within this Statement occurred as a chrono::DateTime if set; None otherwise.

It’s set by the LRS if not provided.

pub fn timestamp_internal(&self) -> Option<&MyTimestamp>

Return the timestamp of when the events described within this Statement occurred if set; None otherwise.

It’s set by the LRS if not provided.

pub fn stored(&self) -> Option<&DateTime<Utc>>

Return the timestamp of when this Statement was persisted if set; None otherwise.

pub fn authority(&self) -> Option<&Actor>

Return the Agent or the Group who is asserting this Statement is TRUE if set or None otherwise.

When provided it should be verified by the LRS based on authentication. It’s set by LRS if not provided, or if a strong trust relationship between the LRP and LRS has not been established.

pub fn version(&self) -> Option<&MyVersion>

Return the Statement’s associated xAPI version if set; None otherwise.

When set, it’s expected to be formatted according to Semantic Versioning 1.0.0.

pub fn attachments(&self) -> &[Attachment]

Return a reference to the potentially empty array of attachments.

pub fn attachments_mut(&mut self) -> &mut [Attachment]

Return a mutable reference to the potentially empty array of attachments.

pub fn set_attachments(&mut self, attachments: Vec<Attachment>)

Set (as in replace) attachments field of this instance to the given value.

pub fn print(&self) -> String

Return a pretty-printed output of self.

pub fn uid(&self) -> u64

Return the fingerprint of this instance.

pub fn equivalent(&self, that: &Statement) -> bool

Return TRUE if this is Equivalent to that and FALSE otherwise.

Trait Implementations

impl Debug for Statement

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Statement

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Statement

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

Formats the value using the given formatter.

impl Fingerprint for Statement

fn fingerprint<H: Hasher>(&self, state: &mut H)

Feed this value into the given Hasher.

fn fingerprint_slice<H: Hasher>(data: &[Self], state: &mut H)

where Self: Sized,

Feeds a slice of this type into the given Hasher.

impl FromStr for Statement

type Err = DataError

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl PartialEq for Statement

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Validate for Statement

fn validate(&self) -> Vec<ValidationError>

IMPORTANT - xAPI mandates that… The LRS shall specifically not consider any of the following for equivalence, nor is it responsible for preservation as described above for the following properties/cases:

• Case (upper vs. lower)
• Id
• Order of any Group Members
• Authority
• Stored
• Timestamp
• Version
• Any attachments
• Any referenced Activity Definitions

fn is_valid(&self) -> bool

Convenience method to quickly assert if the type implementing this trait is indeed valid.

fn check_validity(&self) -> Result<(), ValidationError>

Convenience method that checks the validity of a Validate instance and raises a ValidationError if it was found to be invalid.

impl StructuralPartialEq for Statement