Enum StatementObject

pub enum StatementObject {
    Agent(Agent),
    Group(Group),
    StatementRef(StatementRef),
    SubStatement(Box<SubStatement>),
    Activity(Activity),
}

Enumeration representing the subject (or target) of an action (a Verb) carried out by an Actor (an Agent or a Group) captured in a Statement.

The exact variant of the object is gleaned –explicitly most of the times but implicitly in special cases– from its objectType property value (a variant of ObjectType).

IMPORTANT (rsn) - xAPI (Section 4.2.2 Statement, as well as 4.2.2.3 Object for the Object As Sub-Statement Table) define the Object of a Statement as “Activity, Agent, or another Statement that is the Object of the Statement.” only. However, other sections of the same document mention it can also be a Group. Conformance tests, show that this is the case and that it applies for both Statement and SubStatement.

Variants

Agent(Agent)

The object is an Agent.

Group(Group)

The object is a Group.

StatementRef(StatementRef)

The object is a Statement-Reference.

SubStatement(Box<SubStatement>)

The object is a Sub-Statement.

Activity(Activity)

The object is an Activity.

Implementations

impl StatementObject

pub fn from_activity(obj: Activity) -> Self

Construct a variant from the given Activity instance.

pub fn from_agent(obj: Agent) -> Self

Construct a variant from the given Agent instance.

pub fn from_group(obj: Group) -> Self

Construct a variant from the given Group instance]

pub fn from_statement_ref(obj: StatementRef) -> Self

Construct a variant from the given StatementRef instance.

pub fn from_sub_statement(obj: SubStatement) -> Self

Construct a variant from the given SubStatement instance.

pub fn is_activity(&self) -> bool

Return TRUE if this is an Activity variant or FALSE otherwise.

pub fn is_agent(&self) -> bool

Return TRUE if this is an Agent variant or FALSE otherwise.

pub fn is_group(&self) -> bool

Return TRUE if this is a Group variant or FALSE otherwise.

pub fn is_statement_ref(&self) -> bool

Return TRUE if this is an StatementRef variant or FALSE otherwise.

pub fn is_sub_statement(&self) -> bool

Return TRUE if this is a SubStatement variant or FALSE otherwise.

pub fn as_activity(&self) -> Result<Activity, DataError>

Return the target Activity if it was set; None otherwise.

pub fn as_agent(&self) -> Result<Agent, DataError>

Return the target if it was an Agent. Raise DataError otherwise.

pub fn as_group(&self) -> Result<Group, DataError>

Return the target if it was a Group. Raise DataError otherwise.

pub fn as_statement_ref(&self) -> Result<StatementRef, DataError>

Return the target if it was a Statement-Reference. Raise DataError otherwise.

pub fn as_sub_statement(&self) -> Result<SubStatement, DataError>

Return the target if it was a Sub-Statement. Raise DataError otherwise.

pub fn kind(&self) -> ObjectKind

Return the enum variant kind for this incarnation.

Trait Implementations

impl Debug for StatementObject

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StatementObject

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StatementObject

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

Formats the value using the given formatter.

impl Fingerprint for StatementObject

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 PartialEq for StatementObject

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

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 StatementObject

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

Validate the instance and return a potentially empty collection of ValidationError.

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 StatementObject