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

rlmesh::adapters::CustomEncoding

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

A rotation packing layered on a known native base encoding.

struct CustomEncoding

base

field[source]
base: RotationEncoding

The native encoding the field resolves as.

from_base

field[source]
from_base: Option<EncodingArm>

base -> custom, used when the encoding tags an observation (model) state component. An in- process callable (runs locally, serializes to a <local> marker), or a "module:callable" entrypoint string (a describe-only reference; its execution is deferred). None when action- only.

to_base

field[source]
to_base: Option<EncodingArm>

custom -> base, used when the encoding tags an action component. A callable or entrypoint string (see from_base). None when obs-only.

name

field[source]
name: String

Display name surfaced in Adapter.describe.

new

associated function[source]
fn new(base: RotationEncoding) -> Self

Construct an encoding named custom with neither transform arm set.

is_entrypoint

method[source]
fn is_entrypoint(&self) -> bool

Whether either encoding arm holds an entrypoint string.

width

method[source]
fn width(&self) -> u32

The base rotation encoding’s element width.

Trait implementations

  • impl Clone for CustomEncoding
  • impl Debug for CustomEncoding
  • impl StructuralPartialEq for CustomEncoding
  • impl PartialEq for CustomEncoding
  • impl Eq for CustomEncoding
  • impl Hash for CustomEncoding
  • impl Serialize for CustomEncoding
  • impl<'de> Deserialize<'de> for CustomEncoding
  • impl Display for CustomEncoding