Struct Score

pub struct Score { /* private fields */ }

Structure capturing the outcome of a graded Activity achieved by an Actor.

Implementations

impl Score

pub fn builder() -> ScoreBuilder

Return a Score Builder.

pub fn scaled(&self) -> Option<f32>

Return the score related to the experience as modified by scaling and/or normalization.

Valid values are expected to be w/in [-1.0 .. +1.0] range.

pub fn raw(&self) -> Option<f32>

Return the score achieved by the Actor in the experience described in a Statement. It’s expected not to be modified by any scaling or normalization.

pub fn min(&self) -> Option<f32>

Return the lowest possible score for the experience described by a Statement.

pub fn max(&self) -> Option<f32>

Return the highest possible score for the experience described by a Statement.

Trait Implementations

impl Clone for Score

fn clone(&self) -> Score

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Score

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Score

xAPI mandates few constraints on the values of a Score properties such as:

1. scaled must be w/in the range [-1.0 .. +1.0 ].
2. min must be less than max.
3. raw must be w/in the range [min .. max ].

We make sure these rules are respected while parsing the JSON stream and abort the process if they’re not.

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Score

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

Formats the value using the given formatter.

impl Fingerprint for Score

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 Score

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

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 Score

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 Score