Struct Volume 

pub struct Volume {
    pub id: VolumeId,
    pub region: WorldBox,
    pub role: VolumeRole,
    pub note: Option<String>,
    pub block: Option<String>,
}

A mass the whole itself owns.

Fields

id: VolumeId

Volume id (volume/<kebab>), unique within the plan.

region: WorldBox

The cells it covers.

role: VolumeRole

What the whole is doing with them.

note: Option<String>

What this mass is, for a reader of the plan.

block: Option<String>

The block state this volume is made of. Absent, the block of its kind comes from the plan’s fill (spec-0098 §2b): a massif is the solid fill’s block, or the open fill’s below; a ground is the open fill’s surface over below, or the solid fill’s block. A clearance is air and names no block (DW0193 if it does).

Trait Implementations

impl Clone for Volume

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 Volume

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Volume

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Volume

impl JsonSchema for Volume

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 Volume

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Volume

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 Volume