Struct py_raphtory::edge::PyEdge

pub struct PyEdge { /* private fields */ }

PyEdge is a Python class that represents an edge in the graph. An edge is a directed connection between two vertices.

Implementations

impl PyEdge

PyEdge is a Python class that represents an edge in the graph. An edge is a directed connection between two vertices.

pub fn __getitem__(&self, name: String) -> Option<Prop>

pub fn property( &self, name: String, include_static: Option<bool> ) -> Option<Prop>

Returns the value of the property with the given name. If the property is not found, None is returned. If the property is found, the value of the property is returned.

Arguments: name (str): The name of the property to retrieve.

Returns: The value of the property with the given name.

pub fn property_history(&self, name: String) -> Vec<(i64, Prop)>

Returns the value of the property with the given name all times. If the property is not found, None is returned. If the property is found, the value of the property is returned.

Arguments: name (str): The name of the property to retrieve.

Returns: The value of the property with the given name.

pub fn history(&self) -> Vec<i64>

Returns a list of timestamps of when an edge is added or change to an edge is made.

Returns: A list of timestamps.

pub fn properties(&self, include_static: Option<bool>) -> HashMap<String, Prop>

Returns a dictionary of all properties on the edge.

Arguments: include_static (bool): Whether to include static properties in the result.

Returns: A dictionary of all properties on the edge.

pub fn property_histories(&self) -> HashMap<String, Vec<(i64, Prop)>>

Returns a dictionary of all properties on the edge at all times.

Returns: A dictionary of all properties on the edge at all times.

pub fn property_names(&self, include_static: Option<bool>) -> Vec<String>

Returns a list of all property names on the edge.

Arguments: include_static (bool): Whether to include static properties in the result.

Returns: A list of all property names on the edge.

pub fn has_property(&self, name: String, include_static: Option<bool>) -> bool

Check if a property exists with the given name.

Arguments: name (str): The name of the property to check. include_static (bool): Whether to include static properties in the result.

Returns: True if a property exists with the given name, False otherwise.

pub fn has_static_property(&self, name: String) -> bool

Check if a static property exists with the given name.

Arguments: name (str): The name of the property to check.

Returns: True if a static property exists with the given name, False otherwise.

pub fn static_property(&self, name: String) -> Option<Prop>

pub fn start(&self) -> Option<i64>

Get the start time of the Edge.

Returns: The start time of the Edge.

pub fn start_date_time(&self) -> Option<NaiveDateTime>

Get the start datetime of the Edge.

Returns: the start datetime of the Edge.

pub fn end(&self) -> Option<i64>

Get the end time of the Edge.

Returns: The end time of the Edge.

pub fn end_date_time(&self) -> Option<NaiveDateTime>

Get the end datetime of the Edge.

Returns: The end datetime of the Edge

pub fn window( &self, t_start: Option<&PyAny>, t_end: Option<&PyAny> ) -> PyResult<PyEdge>

Get a new Edge with the properties of this Edge within the specified time window.

Arguments: t_start (int): The start time of the window. t_end (int): The end time of the window.

Returns: A new Edge with the properties of this Edge within the specified time window.

pub fn at(&self, end: &PyAny) -> PyResult<PyEdge>

Get a new Edge with the properties of this Edge at a specified time.

Arguments: end (int): The time to get the properties at.

Returns: A new Edge with the properties of this Edge at a specified time.

pub fn explode(&self) -> PyEdges

Explodes an Edge into a list of PyEdges. This is useful when you want to iterate over the properties of an Edge at every single point in time. This will return a seperate edge each time a property had been changed.

Returns: A list of PyEdges

pub fn earliest_time(&self) -> Option<i64>

Gets the earliest time of an edge.

Returns: (int) The earliest time of an edge

pub fn earliest_date_time(&self) -> Option<NaiveDateTime>

Gets of earliest datetime of an edge.

Returns: the earliest datetime of an edge

pub fn latest_time(&self) -> Option<i64>

Gets the latest time of an edge.

Returns: (int) The latest time of an edge

pub fn latest_date_time(&self) -> Option<NaiveDateTime>

Gets of latest datetime of an edge.

Returns: the latest datetime of an edge

pub fn time(&self) -> Option<i64>

Gets the time of an exploded edge.

Returns: (int) The time of an exploded edge

pub fn layer_name(&self) -> String

Gets the name of the layer this edge belongs to

Returns: (str) The name of the layer

pub fn date_time(&self) -> Option<NaiveDateTime>

Gets the datetime of an exploded edge.

Returns: (datetime) the datetime of an exploded edge

pub fn __repr__(&self) -> String

Displays the Edge as a string.

Trait Implementations

impl<G: GraphViewOps + IntoDynamic> From<EdgeView<G>> for PyEdge

fn from(value: EdgeView<G>) -> Self

Converts to this type from the input type.

impl IntoPy<Py<PyAny>> for PyEdge

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl PyClass for PyEdge

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PyEdge

const DOC: &'static str = _

Class doc string

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

type Layout = PyCell<PyEdge>

Layout

type BaseType = PyAny

Base class

type ThreadChecker = ThreadCheckerStub<PyEdge>

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForPyEdge

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a PyEdge

type Holder = Option<PyRef<'py, PyEdge>>

fn extract(obj: &'py PyAny, holder: &'a mut Self::Holder) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a mut PyEdge

type Holder = Option<PyRefMut<'py, PyEdge>>

fn extract(obj: &'py PyAny, holder: &'a mut Self::Holder) -> PyResult<Self>

impl PyTypeInfo for PyEdge

type AsRefTarget = PyCell<PyEdge>

Utility type to make Py::as_ref work.

const NAME: &'static str = _

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> &PyType

Returns the safe abstraction over the type object.

fn is_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type.

impl Repr for PyEdge

fn repr(&self) -> String