Trait GraphAdapter

pub trait GraphAdapter {
    type NodeId: Id;
    type SocketId: Id;

    // Required methods
    fn nodes(
        &mut self,
    ) -> impl NodeIterator<NodeId = Self::NodeId, SocketId = Self::SocketId>;
    fn connection_hint(
        &self,
        a: Self::SocketId,
        b: Self::SocketId,
    ) -> ConnectionHint;
    fn connect(&mut self, a: Self::SocketId, b: Self::SocketId);
    fn connections(
        &self,
    ) -> impl Iterator<Item = (Self::SocketId, Self::SocketId)>;
}

An adapter for a graph to interact with a visual editor.

Required Associated Types

type NodeId: Id

An identifier used to identify a node over the graph.

type SocketId: Id

An identifier used to identify a socket over the graph.

Required Methods

fn nodes( &mut self, ) -> impl NodeIterator<NodeId = Self::NodeId, SocketId = Self::SocketId>

An iterator over the node’s adapters of the graph.

fn connection_hint( &self, a: Self::SocketId, b: Self::SocketId, ) -> ConnectionHint

A hint about the connection between the sockets a and b.

This hint is used to provide a feedback to the user before they submit the connection.

fn connect(&mut self, a: Self::SocketId, b: Self::SocketId)

The user submit a connection between the sockets a and b.

fn connections(&self) -> impl Iterator<Item = (Self::SocketId, Self::SocketId)>

An iterator over the connections between sockets.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<'a, T> GraphAdapter for &'a mut T

where T: GraphAdapter + ?Sized,

type NodeId = <T as GraphAdapter>::NodeId

type SocketId = <T as GraphAdapter>::SocketId

fn nodes( &mut self, ) -> impl NodeIterator<NodeId = <&'a mut T as GraphAdapter>::NodeId, SocketId = <&'a mut T as GraphAdapter>::SocketId>

fn connection_hint( &self, a: <&'a mut T as GraphAdapter>::SocketId, b: <&'a mut T as GraphAdapter>::SocketId, ) -> ConnectionHint

fn connect( &mut self, a: <&'a mut T as GraphAdapter>::SocketId, b: <&'a mut T as GraphAdapter>::SocketId, )

fn connections( &self, ) -> impl Iterator<Item = (<&'a mut T as GraphAdapter>::SocketId, <&'a mut T as GraphAdapter>::SocketId)>

Implementors