pub struct ActivityDefinition { /* private fields */ }
Expand description
Structure that provides additional information (metadata) related to an Activity.
Implementations§
Source§impl ActivityDefinition
impl ActivityDefinition
Sourcepub fn builder() -> ActivityDefinitionBuilder<'static>
pub fn builder() -> ActivityDefinitionBuilder<'static>
Return an ActivityDefinition Builder.
Sourcepub fn name(&self, tag: &MyLanguageTag) -> Option<&str>
pub fn name(&self, tag: &MyLanguageTag) -> Option<&str>
Return the name
for the given language tag
if it exists; None
otherwise.
Sourcepub fn description(&self, tag: &MyLanguageTag) -> Option<&str>
pub fn description(&self, tag: &MyLanguageTag) -> Option<&str>
Return the description
for the given language tag
if it exists;
None
otherwise.
Sourcepub fn more_info(&self) -> Option<&IriStr>
pub fn more_info(&self) -> Option<&IriStr>
Return the more_info
field if set; None
otherwise.
When set, it’s an IRL that points to information about the associated Activity possibly incl. a way to launch it.
Sourcepub fn interaction_type(&self) -> Option<&InteractionType>
pub fn interaction_type(&self) -> Option<&InteractionType>
Return the interaction_type
field if set; None
otherwise.
Possible values are: true-false
,
choice
,
fill-in
,
long-fill-in
,
matching
,
performance
,
sequencing
,
likert
,
numeric
, and
other
,
Sourcepub fn correct_responses_pattern(&self) -> Option<&Vec<String>>
pub fn correct_responses_pattern(&self) -> Option<&Vec<String>>
Return the correct_responses_pattern
field if set; None
otherwise.
When set, it’s a Vector of patterns representing the correct response to the interaction.
The structure of the patterns vary depending on the interaction_type
.
Sourcepub fn choices(&self) -> Option<&Vec<InteractionComponent>>
pub fn choices(&self) -> Option<&Vec<InteractionComponent>>
Return the choices
field if set; None
otherwise.
When set, it’s a vector of of InteractionComponents representing the correct response to the interaction.
The contents of item(s) in the vector are specific to the given
interaction_type
.
Sourcepub fn scale(&self) -> Option<&Vec<InteractionComponent>>
pub fn scale(&self) -> Option<&Vec<InteractionComponent>>
Return the scale
field if set; None
otherwise.
When set, it’s a vector of of InteractionComponents representing the correct response to the interaction.
The contents of item(s) in the vector are specific to the given
interaction_type
.
Sourcepub fn source(&self) -> Option<&Vec<InteractionComponent>>
pub fn source(&self) -> Option<&Vec<InteractionComponent>>
Return the source
field if set; None
otherwise.
When set, it’s a vector of of InteractionComponents representing the correct response to the interaction.
The contents of item(s) in the vector are specific to the given
interaction_type
.
Sourcepub fn target(&self) -> Option<&Vec<InteractionComponent>>
pub fn target(&self) -> Option<&Vec<InteractionComponent>>
Return the target
field if set; None
otherwise.
When set, it’s a vector of of InteractionComponents representing the correct response to the interaction.
The contents of item(s) in the vector are specific to the given
interaction_type
.
Sourcepub fn steps(&self) -> Option<&Vec<InteractionComponent>>
pub fn steps(&self) -> Option<&Vec<InteractionComponent>>
Return the steps
field if set; None
otherwise.
When set, it’s a vector of of InteractionComponents representing the correct response to the interaction.
The contents of item(s) in the vector are specific to the given
interaction_type
.
Sourcepub fn extensions(&self) -> Option<&Extensions>
pub fn extensions(&self) -> Option<&Extensions>
Return the extensions
field if set; None
otherwise.
Trait Implementations§
Source§impl Canonical for ActivityDefinition
impl Canonical for ActivityDefinition
Source§fn canonicalize(&mut self, language_tags: &[MyLanguageTag])
fn canonicalize(&mut self, language_tags: &[MyLanguageTag])
self
to conform to its canonical format as defined in xAPI
keeping the most appropriate entry given a list of preferred language
tags.Source§impl Clone for ActivityDefinition
impl Clone for ActivityDefinition
Source§fn clone(&self) -> ActivityDefinition
fn clone(&self) -> ActivityDefinition
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ActivityDefinition
impl Debug for ActivityDefinition
Source§impl Default for ActivityDefinition
impl Default for ActivityDefinition
Source§fn default() -> ActivityDefinition
fn default() -> ActivityDefinition
Source§impl<'de> Deserialize<'de> for ActivityDefinition
impl<'de> Deserialize<'de> for ActivityDefinition
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl Display for ActivityDefinition
impl Display for ActivityDefinition
Source§impl PartialEq for ActivityDefinition
impl PartialEq for ActivityDefinition
Source§impl Serialize for ActivityDefinition
impl Serialize for ActivityDefinition
Source§impl Validate for ActivityDefinition
impl Validate for ActivityDefinition
Source§fn validate(&self) -> Vec<ValidationError>
fn validate(&self) -> Vec<ValidationError>
Source§fn is_valid(&self) -> bool
fn is_valid(&self) -> bool
Source§fn check_validity(&self) -> Result<(), ValidationError>
fn check_validity(&self) -> Result<(), ValidationError>
impl StructuralPartialEq for ActivityDefinition
Auto Trait Implementations§
impl Freeze for ActivityDefinition
impl RefUnwindSafe for ActivityDefinition
impl Send for ActivityDefinition
impl Sync for ActivityDefinition
impl Unpin for ActivityDefinition
impl UnwindSafe for ActivityDefinition
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoCollection<T> for T
impl<T> IntoCollection<T> for T
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
Source§impl<T> ToStringFallible for Twhere
T: Display,
impl<T> ToStringFallible for Twhere
T: Display,
Source§fn try_to_string(&self) -> Result<String, TryReserveError>
fn try_to_string(&self) -> Result<String, TryReserveError>
ToString::to_string
, but without panic on OOM.