Struct Reference 

pub struct Reference {
    pub name: String,
    pub shows: String,
    pub time: WorldTime,
    pub weather: WorldWeather,
}

One approved reference image, and the sky it was drawn under.

Fields

name: String

The image’s path stem relative to design/, under concept/ (one scene) or reference/ (a view of the whole map) — e.g. concept/shore-far. The extension is deliberately absent: the name resolves against the directory, and a stem two files answer to is a candidate rather than a match, which DW0890 refuses.

shows: String

One sentence saying what the picture shows. Agent-facing: it is the creator’s own note to the next reader of the record, is never put on a player’s screen, and is not l10n-inventoried.

time: WorldTime

The time of day the picture was drawn under — the creator’s reading of the approved image, and the only creative judgement on this surface.

weather: WorldWeather

The weather the picture was drawn under.

Implementations

impl Reference

pub fn is_valid_name(&self) -> bool

True if Reference::name is concept/<kebab> or reference/<kebab>.

The same shape every id in this DSL takes, for the same reason: a name that resolves to a path needs one spelling, or the record and the directory can disagree about which file a row is about while both look right.

pub fn name_form() -> String

The form a Reference::name has to take, for the refusal that rejected one.

pub fn directory(&self) -> Option<&'static str>

Which of REFERENCE_DIRS this row’s name is under, when it is well-formed.

Trait Implementations

impl Clone for Reference

fn clone(&self) -> Reference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Reference

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Reference

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Reference

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

The name of the generated JSON Schema.

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

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Reference

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Reference

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Reference