Struct rerun::sdk::prelude::GraphEdges

pub struct GraphEdges {
    pub edges: Option<SerializedComponentBatch>,
    pub graph_type: Option<SerializedComponentBatch>,
}

Archetype: A list of edges in a graph.

By default, edges are undirected.

Example

Simple directed graph

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let rec = rerun::RecordingStreamBuilder::new("rerun_example_graph_directed").spawn()?;

    rec.log(
        "simple",
        &[
            &rerun::GraphNodes::new(["a", "b", "c"])
                .with_positions([(0.0, 100.0), (-100.0, 0.0), (100.0, 0.0)])
                .with_labels(["A", "B", "C"]) as &dyn rerun::AsComponents,
            &rerun::GraphEdges::new([("a", "b"), ("b", "c"), ("c", "a")]).with_directed_edges(),
        ],
    )?;

    Ok(())
}

Fields

edges: Option<SerializedComponentBatch>

A list of node tuples.

graph_type: Option<SerializedComponentBatch>

Specifies if the graph is directed or undirected.

If no components::GraphType is provided, the graph is assumed to be undirected.

Implementations

impl GraphEdges

pub fn descriptor_edges() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::edges.

pub fn descriptor_graph_type() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::graph_type.

pub fn descriptor_indicator() -> ComponentDescriptor

Returns the ComponentDescriptor for the associated indicator component.

impl GraphEdges

pub const NUM_COMPONENTS: usize = 3usize

The total number of components in the archetype: 1 required, 2 recommended, 0 optional

impl GraphEdges

pub fn new(edges: impl IntoIterator<Item = impl Into<GraphEdge>>) -> GraphEdges

Create a new GraphEdges.

pub fn update_fields() -> GraphEdges

Update only some specific fields of a GraphEdges.

pub fn clear_fields() -> GraphEdges

Clear all the fields of a GraphEdges.

pub fn columns<I>( self, _lengths: I, ) -> Result<impl Iterator<Item = SerializedComponentColumn>, SerializationError>

where I: IntoIterator<Item = usize> + Clone,

Partitions the component data into multiple sub-batches.

Specifically, this transforms the existing SerializedComponentBatches data into SerializedComponentColumns instead, via SerializedComponentBatch::partitioned.

This makes it possible to use RecordingStream::send_columns to send columnar data directly into Rerun.

The specified lengths must sum to the total length of the component batch.

pub fn columns_of_unit_batches( self, ) -> Result<impl Iterator<Item = SerializedComponentColumn>, SerializationError>

Helper to partition the component data into unit-length sub-batches.

This is semantically similar to calling Self::columns with std::iter::take(1).repeat(n), where n is automatically guessed.

pub fn with_edges( self, edges: impl IntoIterator<Item = impl Into<GraphEdge>>, ) -> GraphEdges

A list of node tuples.

pub fn with_graph_type(self, graph_type: impl Into<GraphType>) -> GraphEdges

Specifies if the graph is directed or undirected.

If no components::GraphType is provided, the graph is assumed to be undirected.

pub fn with_many_graph_type( self, graph_type: impl IntoIterator<Item = impl Into<GraphType>>, ) -> GraphEdges

This method makes it possible to pack multiple crate::components::GraphType in a single component batch.

This only makes sense when used in conjunction with Self::columns. Self::with_graph_type should be used when logging a single row’s worth of data.

impl GraphEdges

pub fn with_undirected_edges(self) -> GraphEdges

Creates a graph with undirected edges.

pub fn with_directed_edges(self) -> GraphEdges

Creates a graph with directed edges.

Trait Implementations

impl Archetype for GraphEdges

type Indicator = GenericIndicatorComponent<GraphEdges>

The associated indicator component, whose presence indicates that the high-level archetype-based APIs were used to log the data.

fn name() -> ArchetypeName

The fully-qualified name of this archetype, e.g. rerun.archetypes.Points2D.

fn display_name() -> &'static str

Readable name for displaying in UI.

fn indicator() -> SerializedComponentBatch

Creates a ComponentBatch out of the associated Self::Indicator component.

fn required_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that must be provided by the user when constructing this archetype.

fn recommended_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that should be provided by the user when constructing this archetype.

fn optional_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that may be provided by the user when constructing this archetype.

fn all_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that must, should and may be provided by the user when constructing this archetype.

fn from_arrow_components( arrow_data: impl IntoIterator<Item = (ComponentDescriptor, Arc<dyn Array>)>, ) -> Result<GraphEdges, DeserializationError>

Given an iterator of Arrow arrays and their respective ComponentNames, deserializes them into this archetype.

fn from_arrow( data: impl IntoIterator<Item = (Field, Arc<dyn Array>)>, ) -> Result<Self, DeserializationError>

where Self: Sized,

Given an iterator of Arrow arrays and their respective field metadata, deserializes them into this archetype.

impl AsComponents for GraphEdges

fn as_serialized_batches(&self) -> Vec<SerializedComponentBatch>

Exposes the object’s contents as a set of SerializedComponentBatches.

fn to_arrow(&self) -> Result<Vec<(Field, Arc<dyn Array>)>, SerializationError>

Serializes all non-null Components of this bundle into Arrow arrays.

impl Clone for GraphEdges

fn clone(&self) -> GraphEdges

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GraphEdges

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

Formats the value using the given formatter.

impl Default for GraphEdges

fn default() -> GraphEdges

Returns the “default value” for a type.

impl PartialEq for GraphEdges

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SizeBytes for GraphEdges

fn heap_size_bytes(&self) -> u64

Returns how many bytes self uses on the heap.

fn total_size_bytes(&self) -> u64

Returns the total size of self in bytes, accounting for both stack and heap space.

fn stack_size_bytes(&self) -> u64

Returns the total size of self on the stack, in bytes.

fn is_pod() -> bool

Is Self just plain old data?

impl ArchetypeReflectionMarker for GraphEdges

impl StructuralPartialEq for GraphEdges