Struct EntityRef 

pub struct EntityRef {
    pub entity_type: ContentEntityType,
    pub entity_id: Uuid,
    pub label: String,
}

A content entity and what people call it.

Fields

entity_type: ContentEntityType

entity_id: Uuid

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

label: String

A page title, chapter, module or course name, glossary term or citation key; empty for the default module and the course default review config.

Implementations

impl EntityRef

pub fn of( _: EntityKey, preferred: Option<&EntitySnapshot>, fallback: Option<&EntitySnapshot>, ) -> Self

The entity, labelled from preferred if it exists and from fallback otherwise; with an empty label if neither does.

pub fn key(&self) -> EntityKey

The entity’s key.

Trait Implementations

impl Clone for EntityRef

fn clone(&self) -> EntityRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for EntityRef

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

impl Debug for EntityRef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EntityRef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for EntityRef

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

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 EntityRef

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 Eq for EntityRef

impl StructuralPartialEq for EntityRef