Skip to main content

FieldDef

Struct FieldDef 

Source
pub struct FieldDef {
    pub name: String,
    pub field_type: FieldType,
    pub mutability: FieldMutability,
    pub units: Option<String>,
    pub bounds: Option<(f32, f32)>,
    pub boundary_behavior: BoundaryBehavior,
}
Expand description

Definition of a field registered in a simulation world.

Fields are the fundamental unit of per-cell state. Each field has a type, mutability class, optional bounds, and boundary behavior. Fields are registered at world creation; FieldId is the index into the field list.

§Examples

use murk_core::{FieldDef, FieldType, FieldMutability, BoundaryBehavior};

// A scalar field that is reallocated every tick.
let heat = FieldDef {
    name: "heat".into(),
    field_type: FieldType::Scalar,
    mutability: FieldMutability::PerTick,
    units: Some("kelvin".into()),
    bounds: Some((0.0, 1000.0)),
    boundary_behavior: BoundaryBehavior::Clamp,
};

// A 3D velocity vector allocated once (static terrain data).
let velocity = FieldDef {
    name: "wind".into(),
    field_type: FieldType::Vector { dims: 3 },
    mutability: FieldMutability::Static,
    units: None,
    bounds: None,
    boundary_behavior: BoundaryBehavior::Clamp,
};

Fields§

§name: String

Human-readable name for debugging and logging.

§field_type: FieldType

Data type and dimensionality.

§mutability: FieldMutability

Allocation strategy across ticks.

§units: Option<String>

Optional unit annotation (e.g., "meters/sec").

§bounds: Option<(f32, f32)>

Optional (min, max) bounds for field values.

§boundary_behavior: BoundaryBehavior

Behavior when values exceed declared bounds.

Trait Implementations§

Source§

impl Clone for FieldDef

Source§

fn clone(&self) -> FieldDef

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FieldDef

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for FieldDef

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for FieldDef

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.