Struct NeighborData 

pub struct NeighborData {
    pub source_bin: u32,
    pub frame_id: u64,
    pub value: Complex,
    pub magnitude: f32,
    pub phase: f32,
    pub phase_derivative: f32,
    pub spectral_flux: f32,
}

Neighbor data exchanged via K2K messaging.

Fields

source_bin: u32

Source bin index.

frame_id: u64

Frame ID.

value: Complex

Complex value.

magnitude: f32

Magnitude.

phase: f32

Phase.

phase_derivative: f32

Temporal derivative (phase change from previous frame).

spectral_flux: f32

Spectral flux (magnitude change).

Implementations

impl NeighborData

pub fn from_bin( bin: &FrequencyBin, phase_derivative: f32, spectral_flux: f32, ) -> Self

Create neighbor data from a frequency bin.

Trait Implementations

impl Archive for NeighborData

where u32: Archive, u64: Archive, Complex: Archive, f32: Archive,

type Archived = ArchivedNeighborData

The archived representation of this type.

type Resolver = NeighborDataResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

unsafe fn resolve( &self, pos: usize, resolver: Self::Resolver, out: *mut Self::Archived, )

Creates the archived version of this value at the given position and writes it to the given output.

impl Clone for NeighborData

fn clone(&self) -> NeighborData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NeighborData

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

Formats the value using the given formatter.

impl<__D: Fallible + ?Sized> Deserialize<NeighborData, __D> for Archived<NeighborData>

where u32: Archive, Archived<u32>: Deserialize<u32, __D>, u64: Archive, Archived<u64>: Deserialize<u64, __D>, Complex: Archive, Archived<Complex>: Deserialize<Complex, __D>, f32: Archive, Archived<f32>: Deserialize<f32, __D>,

fn deserialize( &self, deserializer: &mut __D, ) -> Result<NeighborData, __D::Error>

Deserializes using the given deserializer

impl RingMessage for NeighborData

fn message_type() -> u64

Get the message type discriminator.

fn message_id(&self) -> MessageId

Get the message ID.

fn serialize(&self) -> Vec<u8>

Serialize the message to bytes.

fn deserialize(bytes: &[u8]) -> Result<Self>

Deserialize a message from bytes.

fn correlation_id(&self) -> CorrelationId

Get the correlation ID (if any).

fn priority(&self) -> Priority

Get the priority.

fn size_hint(&self) -> usize

where Self: Sized,

Get the serialized size hint.

impl<__S: Fallible + ?Sized> Serialize<__S> for NeighborData

where u32: Serialize<__S>, u64: Serialize<__S>, Complex: Serialize<__S>, f32: Serialize<__S>,

fn serialize(&self, serializer: &mut __S) -> Result<Self::Resolver, __S::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.