Struct py_raphtory::vertex::PyVertex

pub struct PyVertex { /* private fields */ }

A vertex (or node) in the graph.

Implementations

impl PyVertex

Defines the Vertex, which represents a vertex in the graph. A vertex is a node in the graph, and can have properties and edges. It can also be used to navigate the graph.

pub fn id(&self) -> u64

Returns the id of the vertex. This is a unique identifier for the vertex.

Returns: The id of the vertex as an integer.

pub fn name(&self) -> String

Returns the name of the vertex.

Returns: The name of the vertex as a string.

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

Returns the earliest time that the vertex exists.

Arguments: None

Returns: The earliest time that the vertex exists as an integer.

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

Returns the earliest datetime that the vertex exists.

Arguments: None

Returns: The earliest datetime that the vertex exists as an integer.

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

Returns the latest time that the vertex exists.

Returns: The latest time that the vertex exists as an integer.

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

Returns the latest datetime that the vertex exists.

Arguments: None

Returns: The latest datetime that the vertex exists as an integer.

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

Gets the property value of this vertex given the name of the property.

Arguments: name: The name of the property. include_static: Whether to include static properties. Defaults to true.

Returns: The property value as a Prop object.

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

Returns the history of a property value of a vertex at all times

Arguments: name: The name of the property.

Returns: A list of tuples of the form (time, value) where time is an integer and value is a Prop object.

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

Returns all the properties of the vertex as a dictionary.

Arguments: include_static: Whether to include static properties. Defaults to true.

Returns: A dictionary of the form {name: value} where name is a string and value is a Prop object.

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

Returns all the properties of the vertex as a dictionary including the history of each property.

Arguments: include_static: Whether to include static properties. Defaults to true.

Returns: A dictionary of the form {name: [(time, value)]} where name is a string, time is an integer, and value is a Prop object.

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

Returns the names of all the properties of the vertex.

Arguments: include_static: Whether to include static properties. Defaults to true.

Returns: A list of strings of propert names.

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

Checks if a property exists on this vertex.

Arguments: name: The name of the property. include_static: Whether to include static properties. Defaults to true.

Returns: True if the property exists, false otherwise.

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

Checks if a static property exists on this vertex.

Arguments: name: The name of the property.

Returns: True if the property exists, false otherwise.

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

Returns the static property value of this vertex given the name of the property.

Arguments: name: The name of the property.

Returns: The property value as a Prop object or None if the property does not exist.

pub fn degree(&self) -> usize

Get the degree of this vertex (i.e., the number of edges that are incident to it).

Returns The degree of this vertex.

pub fn in_degree(&self) -> usize

Get the in-degree of this vertex (i.e., the number of edges that are incident to it from other vertices).

Returns: The in-degree of this vertex.

pub fn out_degree(&self) -> usize

Get the out-degree of this vertex (i.e., the number of edges that are incident to it from this vertex).

Returns: The out-degree of this vertex.

pub fn edges(&self) -> PyEdges

Get the edges that are pointing to or from this vertex.

Returns: A list of Edge objects.

pub fn in_edges(&self) -> PyEdges

Get the edges that are pointing to this vertex.

Returns: A list of Edge objects.

pub fn out_edges(&self) -> PyEdges

Get the edges that are pointing from this vertex.

Returns: A list of Edge objects.

pub fn neighbours(&self) -> PyPathFromVertex

Get the neighbours of this vertex.

Returns:

A list of Vertex objects.

pub fn in_neighbours(&self) -> PyPathFromVertex

Get the neighbours of this vertex that are pointing to it.

Returns: A list of Vertex objects.

pub fn out_neighbours(&self) -> PyPathFromVertex

Get the neighbours of this vertex that are pointing from it.

Returns: A list of Vertex objects.

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

Gets the earliest time that this vertex is valid.

Returns: The earliest time that this vertex is valid or None if the vertex is valid for all times.

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

Gets the earliest datetime that this vertex is valid

Returns: The earliest datetime that this vertex is valid or None if the vertex is valid for all times.

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

Gets the latest time that this vertex is valid.

Returns: The latest time that this vertex is valid or None if the vertex is valid for all times.

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

Gets the latest datetime that this vertex is valid

Returns: The latest datetime that this vertex is valid or None if the vertex is valid for all times.

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

Create a view of the vertex including all events between t_start (inclusive) and t_end (exclusive)

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

Returns: A PyVertex object.

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

Create a view of the vertex including all events at t.

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

Returns: A PyVertex object.

pub fn default_layer(&self) -> PyVertex

Create a view including all the edges in the default layer

Returns: a view including all the edges in the default layer

pub fn layer(&self, name: &str) -> Option<PyVertex>

Create a view including all the edges in the layer name

Arguments: name (str) : the name of the layer

Returns: a view including all the edges in the layer name

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

Returns the history of a vertex, including vertex additions and changes made to vertex.

Returns: A list of timestamps of the event history of vertex.

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

pub fn __repr__(&self) -> String

Display the vertex as a string.

Trait Implementations

impl Clone for PyVertex

fn clone(&self) -> PyVertex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<PyVertex> for VertexRef

Converts a python vertex into a rust vertex.

fn from(value: PyVertex) -> Self

Converts to this type from the input type.

impl<G: GraphViewOps + IntoDynamic> From<VertexView<G>> for PyVertex

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

Converts to this type from the input type.

impl IntoPy<Py<PyAny>> for PyVertex

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

Performs the conversion.

impl PyClass for PyVertex

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PyVertex

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<PyVertex>

Layout

type BaseType = PyAny

Base class

type ThreadChecker = ThreadCheckerStub<PyVertex>

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForPyVertex

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 PyVertex

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

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

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

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

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

impl PyTypeInfo for PyVertex

type AsRefTarget = PyCell<PyVertex>

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 PyVertex

fn repr(&self) -> String