Struct InteractionComponent

pub struct InteractionComponent { /* private fields */ }

Depending on the value of the interactionType property of an ActivityDefinition, an Activity can provide additional properties, each potentially being a list of InteractionComponents.

Implementations

impl InteractionComponent

pub fn builder() -> InteractionComponentBuilder<'static>

Return an InteractionComponent Builder.

pub fn id(&self) -> &str

Return the id field.

pub fn description(&self, tag: &MyLanguageTag) -> Option<&str>

Return description (e.g. the text for a given choice in a multiple- choice interaction) in the designated language tag if it exists; None otherwise.

Trait Implementations

impl Canonical for InteractionComponent

fn canonicalize(&mut self, tags: &[MyLanguageTag])

Reduce self to conform to its canonical format as defined in xAPI keeping the most appropriate entry given a list of preferred language tags.

impl Clone for InteractionComponent

fn clone(&self) -> InteractionComponent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InteractionComponent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InteractionComponent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for InteractionComponent

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

Formats the value using the given formatter.

impl PartialEq for InteractionComponent

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

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 InteractionComponent

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 InteractionComponent