Struct MagnetConnection 

#[non_exhaustive]
pub struct MagnetConnection {
    pub from: MagnetRef,
    pub to: MagnetRef,
    pub payload: Option<Rc<dyn Any>>,
}

A formed connection between two magnets, delivered to the consumer’s on_connect handler on release (mouse) or confirm (keyboard).

from is the magnet that initiated the connection (the dragged item’s magnet, the grabbed port, or the keyboard-activated source); to is the magnet it connected onto. payload is whatever the predicate’s MagnetVerdict::Accept carried.

#[non_exhaustive]: the crate hands this to consumer code — it is the argument of on_connect. Build one with new.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

from: MagnetRef

The initiating magnet.

to: MagnetRef

The receiving magnet.

payload: Option<Rc<dyn Any>>

The connection payload from the accepting verdict, if any.

Implementations

impl MagnetConnection

pub fn new(from: MagnetRef, to: MagnetRef, payload: Option<Rc<dyn Any>>) -> Self

A connection stated field by field — the constructor #[non_exhaustive] takes the place of a struct literal for. The scene builds its own; this is for a consumer testing on_connect.

pub fn payload_as<P: 'static>(&self) -> Option<&P>

Borrow the connection payload downcast to P.

Trait Implementations

impl Clone for MagnetConnection

fn clone(&self) -> MagnetConnection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MagnetConnection

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

Formats the value using the given formatter.