Struct EmitterDescriptor 

pub struct EmitterDescriptor {
    pub kind: Symbol,
    pub id: String,
    pub anchor_m: Vec<f64>,
    pub direction: Option<Vec<f64>>,
    pub amplitude: f64,
    pub phase_rad: f64,
}

Citizen descriptor for a point or forward-plane coherent emitter.

Fields

kind: Symbol

interference/point or interference/forward-plane.

id: String

Stable source identity.

anchor_m: Vec<f64>

Point position or a point on the zero-phase plane, in metres.

direction: Option<Vec<f64>>

Forward direction; absent for a point source.

amplitude: f64

Field amplitude at the point reference distance or zero-phase plane.

phase_rad: f64

Source phase in radians, canonically stored in [-pi, pi).

Implementations

impl EmitterDescriptor

pub fn from_emitter(emitter: &Emitter) -> Self

Projects a checked domain emitter.

pub fn to_emitter(&self) -> Result<Emitter>

Reconstructs the checked domain emitter.

Trait Implementations

impl Citizen for EmitterDescriptor

fn citizen_symbol() -> Symbol

The citizen’s namespace/name class symbol.

fn citizen_version() -> u32

The citizen’s encoding version.

fn citizen_arity() -> usize

Number of constructor fields (excluding the version argument).

fn citizen_fields() -> &'static [&'static str]

The citizen’s field names, in constructor order.

impl CitizenRuntime for EmitterDescriptor

fn citizen_info() -> CitizenInfo

Returns the static registry row for this citizen type.

fn conformance(cx: &mut Cx) -> Result<()>

Runs this citizen’s conformance fixture set.

fn construct_from_values(cx: &mut Cx, args: Vec<Value>) -> Result<Self>

Builds the citizen from decoded constructor argument values.

fn example() -> Self

Returns the canonical example value used as a conformance fixture.

fn install(linker: &mut Linker<'_>) -> Result<(), Error>

where Self: Sized,

Installs this citizen’s class into a kernel linker.

impl Clone for EmitterDescriptor

fn clone(&self) -> EmitterDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EmitterDescriptor

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

Formats the value using the given formatter.

impl Object for EmitterDescriptor

fn display(&self, cx: &mut Cx) -> Result<String>

Render the object as a human-readable display string.

fn as_any(&self) -> &dyn Any

Expose the object for Rust downcasting.

fn header(&self) -> &ObjectHeader

Identity and trust header for the object; defaults to the shared anonymous header.

fn op(&self, _key: &OpKey) -> Option<&dyn Op>

Resolve the operation registered under key, if any.

fn claims( &self, _cx: &mut Cx, _pattern: &ClaimPattern, _sink: &mut dyn ClaimSink, ) -> Result<(), Error>

Emit the object’s claims matching pattern into sink.

fn snapshot(&self, _cx: &mut Cx) -> Result<Option<Datum>, Error>

Optional content-addressable snapshot of the object’s state.

impl ObjectCompat for EmitterDescriptor

fn class(&self, cx: &mut Cx) -> Result<ClassRef>

Class object this value belongs to; defaults to nil.

fn as_expr(&self, cx: &mut Cx) -> Result<Expr>

Expression form of the object; defaults to an opaque extension node.

fn as_object_encoder(&self) -> Option<&dyn ObjectEncode>

Object-encoder view, if the object encodes other objects.

fn as_callable(&self) -> Option<&dyn Callable>

Callable view, if the object can be invoked.

fn as_class(&self) -> Option<&dyn Class>

Class view, if the object is a class.

fn as_shape(&self) -> Option<&dyn Shape>

Shape view, if the object is a shape.

fn as_read_constructor(&self) -> Option<&dyn ReadConstructor>

Read-constructor view, if the object decodes data forms.

fn as_number_domain(&self) -> Option<&(dyn NumberDomain + 'static)>

Number-domain view, if the object is a number domain.

fn as_number_value(&self) -> Option<&dyn NumberValue>

Number-value view, if the object is a domain number.

fn as_eval_fabric(&self) -> Option<&dyn EvalFabric>

Eval-fabric view, if the object is a distributed eval surface.

fn as_stream(&self) -> Option<&dyn Stream>

Stream view, if the object is a stream.

fn as_sequence(&self) -> Option<&dyn Sequence>

Sequence view, if the object is a sequence.

fn as_thunk(&self) -> Option<&dyn Thunk>

Thunk view, if the object is a deferred computation.

fn as_list(&self) -> Option<&(dyn ListValue + 'static)>

List view, if the object is a list value.

fn as_table_impl(&self) -> Option<&(dyn Table + 'static)>

Table-implementation view, if the object is a table.

fn as_dir(&self) -> Option<&(dyn Dir + 'static)>

Directory view, if the object is a directory.

fn truth(&self, _cx: &mut Cx) -> Result<bool, Error>

Truthiness of the object; defaults to true.

fn publish_shape_satisfaction_claims( &self, _cx: &mut Cx, _shape: &Ref, ) -> Result<bool, Error>

Publish claims asserting that the object satisfies shape; returns whether any were published.

fn as_table(&self, cx: &mut Cx) -> Result<Value, Error>

Project the object into a table value; the default exposes its display.

impl ObjectEncode for EmitterDescriptor

fn object_encoding(&self, cx: &mut Cx) -> Result<ObjectEncoding>

Returns the ObjectEncoding this object should be rendered as.

impl PartialEq for EmitterDescriptor

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for EmitterDescriptor