Enum EntitySnapshot 

pub enum EntitySnapshot {
    Page(PageSnapshot),
    Chapter(ChapterSnapshot),
    Module(ModuleSnapshot),
    CourseSettings(CourseSettingsSnapshot),
    GlossaryTerm(GlossaryTermSnapshot),
    Reference(ReferenceSnapshot),
    CourseDefaultReviewConfig(CourseDefaultReviewConfigSnapshot),
}

A snapshot of any entity type an agent changeset can hold. Serialised as the bare snapshot; stored ones are parsed with EntitySnapshot::from_json, which knows the type.

Variants

Page(PageSnapshot)

Chapter(ChapterSnapshot)

Module(ModuleSnapshot)

CourseSettings(CourseSettingsSnapshot)

GlossaryTerm(GlossaryTermSnapshot)

Reference(ReferenceSnapshot)

CourseDefaultReviewConfig(CourseDefaultReviewConfigSnapshot)

Implementations

impl EntitySnapshot

pub fn from_json( entity_type: ContentEntityType, json: &str, ) -> ModelResult<Self>

Parses a stored snapshot. Errors if json is not in the shape of entity_type.

pub fn entity_type(&self) -> ContentEntityType

The kind of entity the snapshot holds.

pub fn entity_id(&self) -> Uuid

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

pub fn course_id(&self) -> Uuid

The course the entity belongs to.

pub fn key(&self) -> EntityKey

The entity’s key.

pub fn label(&self) -> &str

See EntityRef::label.

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

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

pub fn digest(&self) -> ModelResult<String>

A digest that two snapshots share exactly when they are equal, for storing in place of a snapshot that is only compared.

Trait Implementations

impl Clone for EntitySnapshot

fn clone(&self) -> EntitySnapshot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for EntitySnapshot

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

impl Debug for EntitySnapshot

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

Formats the value using the given formatter.

impl From<ChapterSnapshot> for EntitySnapshot

fn from(snapshot: ChapterSnapshot) -> Self

Converts to this type from the input type.

impl From<CourseDefaultReviewConfigSnapshot> for EntitySnapshot

fn from(snapshot: CourseDefaultReviewConfigSnapshot) -> Self

Converts to this type from the input type.

impl From<CourseSettingsSnapshot> for EntitySnapshot

fn from(snapshot: CourseSettingsSnapshot) -> Self

Converts to this type from the input type.

impl From<GlossaryTermSnapshot> for EntitySnapshot

fn from(snapshot: GlossaryTermSnapshot) -> 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 From<PageSnapshot> for EntitySnapshot

fn from(snapshot: PageSnapshot) -> Self

Converts to this type from the input type.

impl From<ReferenceSnapshot> for EntitySnapshot

fn from(snapshot: ReferenceSnapshot) -> Self

Converts to this type from the input type.

impl HasFields for EntitySnapshot

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

impl PartialEq for EntitySnapshot

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

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 EntitySnapshot

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 EntitySnapshot