Struct JigData

pub struct JigData {

    pub created_at: DateTime<Utc>,
    pub last_edited: Option<DateTime<Utc>>,
    pub draft_or_live: DraftOrLive,
    pub display_name: String,
    pub modules: Vec<LiteModule>,
    pub age_ranges: Vec<AgeRangeId>,
    pub affiliations: Vec<AffiliationId>,
    pub language: String,
    pub categories: Vec<CategoryId>,
    pub additional_resources: Vec<AdditionalResource>,
    pub description: String,
    pub default_player_settings: JigPlayerSettings,
    pub theme: ThemeId,
    pub audio_background: Option<AudioBackground>,
    pub audio_effects: AudioEffects,
    pub privacy_level: PrivacyLevel,
    pub locked: bool,
    pub other_keywords: String,
    pub translated_keywords: String,
    pub translated_description: HashMap<String, String>,
}

The over-the-wire representation of a JIG’s data. This can either be the live copy or the draft copy.

Fields

created_at: DateTime<Utc>

When the JIG was first created.

last_edited: Option<DateTime<Utc>>

When the jig was last edited

draft_or_live: DraftOrLive

Whether the JIG data is the live copy or the draft.

display_name: String

The JIG’s name.

modules: Vec<LiteModule>

The JIG’s remaining modules.

NOTE: the first module will always exist and will always be of type cover

age_ranges: Vec<AgeRangeId>

This jig’s age ranges.

affiliations: Vec<AffiliationId>

This jig’s affiliations.

language: String

The language the jig uses.

NOTE: in the format en, eng, en-US, eng-US or eng-USA. To be replaced with a struct that enforces this.

categories: Vec<CategoryId>

The jig’s categories.

additional_resources: Vec<AdditionalResource>

Additional resources of this JIG.

description: String

Description of the jig.

default_player_settings: JigPlayerSettings

Default player settings for this jig.

theme: ThemeId

Theme for this jig, identified by [ThemeId](module::body::ThemeId).

audio_background: Option<AudioBackground>

Background audio

audio_effects: AudioEffects

Audio effects

privacy_level: PrivacyLevel

The privacy level on the JIG.

locked: bool

Lock this jig

other_keywords: String

Other keywords used to searched for jigs

translated_keywords: String

translated keywords used to searched for jigs

translated_description: HashMap<String, String>

translated descriptions

Trait Implementations

impl Clone for JigData

fn clone(&self) -> JigData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JigData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for JigData

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for JigData

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

where __S: Serializer,

Serialize this value into the given Serde serializer.