Struct ModuleSnapshot 

pub struct ModuleSnapshot {
    pub id: Uuid,
    pub course_id: Uuid,
    pub name: Option<String>,
    pub order_number: i32,
    pub completion_policy: CompletionPolicy,
    pub certification_enabled: bool,
    pub uh_course_code: Option<String>,
    pub ects_credits: Option<f32>,
    pub completion_registration_link_override: Option<String>,
    pub completions_can_be_registered_to_sisu: bool,
}

A course module’s structure fields and settings.

Fields

id: Uuid

course_id: Uuid

name: Option<String>

None only for the course’s default module.

order_number: i32

0 only for the course’s default module.

completion_policy: CompletionPolicy

certification_enabled: bool

uh_course_code: Option<String>

ects_credits: Option<f32>

completion_registration_link_override: Option<String>

completions_can_be_registered_to_sisu: bool

Implementations

impl ModuleSnapshot

pub fn new(id: Uuid, course_id: Uuid) -> Self

A new, unnamed module with the settings modules created in the editor get.

Trait Implementations

impl Clone for ModuleSnapshot

fn clone(&self) -> ModuleSnapshot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for ModuleSnapshot

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl ContentEntity for ModuleSnapshot

const ENTITY_TYPE: ContentEntityType = ContentEntityType::Module

fn id(&self) -> Uuid

The entity’s id; the course id for course settings.

fn course_id(&self) -> Uuid

fn label(&self) -> &str

See EntityRef::label.

fn narrow(snapshot: &EntitySnapshot) -> Option<&Self>

The snapshot, if it is of this kind.

async fn load_live( conn: &mut PgConnection, ids: &[Uuid], ) -> ModelResult<HashMap<Uuid, Self>>

The live entities with the ids, as load_live_many has them, by id.

async fn lock_rows(conn: &mut PgConnection, ids: &[Uuid]) -> ModelResult<()>

Locks the entities’ rows until the transaction ends. Soft-deleted rows are locked too: a publish can restore them. ids must be sorted, so that concurrent lockers take the rows in the same order.

fn parent(&self) -> Option<EntityKey>

The chapter or module the entity is placed in; None for entities of the course itself.

impl Debug for ModuleSnapshot

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ModuleSnapshot

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CourseModule> for ModuleSnapshot

fn from(module: CourseModule) -> Self

Converts to this type from the input type.

impl From<ModuleSnapshot> for EntitySnapshot

fn from(snapshot: ModuleSnapshot) -> Self

Converts to this type from the input type.

impl HasFields for ModuleSnapshot

fn fields(&self) -> Vec<(EntityField, Option<FieldValue>)>

impl InCourseState for ModuleSnapshot

fn find_in(state: &CourseState, id: Uuid) -> Option<&Self>

The entity in state. Always None for pages, which states hold as PageRecords.

fn put_in(&self, state: &mut CourseState)

Adds the entity to state, or replaces it there.

fn remove_from(state: &mut CourseState, id: Uuid)

Removes the entity from state; course settings stay, since a course always has them.

fn is_in(state: &CourseState, id: Uuid) -> bool

impl PartialEq for ModuleSnapshot

fn eq(&self, other: &ModuleSnapshot) -> bool

Tests for self and other values to be equal, and is used by ==.

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 ModuleSnapshot

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for ModuleSnapshot

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference [utoipa::openapi::schema::Schema]s for this type.

impl StructuralPartialEq for ModuleSnapshot