Struct PagePreview 

pub struct PagePreview {
    pub course_name: String,
    pub language_code: String,
    pub page: PreviewPage,
    pub is_chapter_front_page: bool,
    pub is_published_state: bool,
    pub references: Vec<PreviewReference>,
    pub changed_pages: Vec<PreviewPageLink>,
    pub chapter_pages: Vec<PreviewPageLink>,
}

What the preview of a staged page, or of a published one, renders.

Fields

course_name: String

language_code: String

page: PreviewPage

The page as staged, or as live if the changeset does not change it.

is_chapter_front_page: bool

Whether the page is its chapter’s front page, as staged.

is_published_state: bool

Whether the preview shows the published course rather than a changeset’s staged state.

references: Vec<PreviewReference>

The course’s references, with the changeset’s staged changes applied if there is one.

changed_pages: Vec<PreviewPageLink>

The pages the link switches between: the changeset’s added or changed pages, or all pages of the course for a published preview. Empty unless the link covers more than one page.

chapter_pages: Vec<PreviewPageLink>

The visible pages of the page’s chapter after its front page; filled only for a chapter front page when the link covers more than one page.

Trait Implementations

impl Clone for PagePreview

fn clone(&self) -> PagePreview

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for PagePreview

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

impl Debug for PagePreview

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PagePreview

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PagePreview

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

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 PagePreview

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 PagePreview