This reference describes unreleased code on main; no release documents it yet.

rlmesh::adapters::Field

structPreviewuse rlmesh::adapters::Field;[source]

One contiguous field of a flat numeric observation leaf.

struct Field

role

field[source]
role: Option<String>

Semantic role matched against model state parts, or None to skip this slice.

dim

field[source]
dim: u32

Number of elements this field occupies.

encoding

field[source]
encoding: Option<Vec<Tolerant<RotationEncoding>>>

Rotation encoding when the field is a rotation. A single encoding, or a sequence of them (native first) for negotiation.

range

field[source]
range: Option<(f64, f64)>

Optional (low, high) value range for this field’s slice, supplying the bounds where the space leaves it unbounded. If the space declares finite bounds for the slice that disagree with it, resolution errors rather than silently overriding them.

frame

field[source]
frame: Option<Tolerant<Frame>>

Coordinate frame this field’s values are expressed in; see :attr:StateTag.frame. A role- less skip may not carry one.

provenance

field[source]
provenance: Option<Tolerant<Provenance>>

Where this field’s numbers come from; see :attr:StateTag.provenance. A role-less skip may not carry one.

part

field[source]
part: Option<String>

The body part this field belongs to; see :attr:StateTag.part. A role-less skip may not carry one.

labels

field[source]
labels: Option<Vec<String>>

The axis names of this field, dim of them; see :attr:StateTag.labels. A role-less skip may not carry them.

Trait implementations

  • impl Clone for Field
  • impl Debug for Field
  • impl StructuralPartialEq for Field
  • impl PartialEq for Field
  • impl Serialize for Field
  • impl<'de> Deserialize<'de> for Field
  • impl Default for Field
  • impl Display for Field