Struct BranchDecl 

pub struct BranchDecl {
    pub id: BranchId,
    pub flags: Vec<FlagId>,
    pub leads_to: String,
}

One alternative of a BranchPoint (DSL v0.8, spec-0025).

Fields

id: BranchId

Unique branch id (campaign-wide — it names the emitted chronicle file).

flags: Vec<FlagId>

The subset of the point’s forks_on that is SET on this branch. The rest of forks_on is pinned unset. An empty list is legal — the “took neither option” branch — as long as it is genuinely reachable.

leads_to: String

Where this branch goes: either the quest/<kebab> the branches converge at, or the ending/<kebab> this branch runs to.

One field, not two mutually exclusive ones, because the id prefix already says which it is — the same convention every cross-stage reference in the DSL uses. That is what makes “exactly one of them” an unrepresentable state rather than a rule some diagnostic has to police: a value that is neither a syntactically valid quest/… nor ending/… is the ordinary malformed-id DW0110, and one that names nothing is the ordinary dangling-reference DW0112.

Implementations

impl BranchDecl

pub fn converges_at(&self) -> Option<QuestId>

The convergence quest, if Self::leads_to names one.

pub fn ending(&self) -> Option<EndingId>

The ending, if Self::leads_to names one.

Trait Implementations

impl Clone for BranchDecl

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BranchDecl

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BranchDecl

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for BranchDecl

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 BranchDecl

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for BranchDecl

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 BranchDecl