Struct py_raphtory::graph_view::PyGraphView

pub struct PyGraphView {
    pub graph: DynamicGraph,
}

Graph view is a read-only version of a graph at a certain point in time.

Fields

graph: DynamicGraph

Implementations

impl PyGraphView

The API for querying a view of the graph in a read-only state

pub fn get_unique_layers(&self) -> Vec<String>

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

Timestamp of earliest activity in the graph

Returns: the timestamp of the earliest activity in the graph

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

DateTime of earliest activity in the graph

Returns: the datetime of the earliest activity in the graph

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

Timestamp of latest activity in the graph

Returns: the timestamp of the latest activity in the graph

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

DateTime of latest activity in the graph

Returns: the datetime of the latest activity in the graph

pub fn num_edges(&self) -> usize

Number of edges in the graph

Returns: the number of edges in the graph

pub fn num_vertices(&self) -> usize

Number of vertices in the graph

Returns: the number of vertices in the graph

pub fn has_vertex(&self, id: &PyAny) -> PyResult<bool>

Returns true if the graph contains the specified vertex

Arguments: id (str or int): the vertex id

Returns: true if the graph contains the specified vertex, false otherwise

pub fn has_edge( &self, src: &PyAny, dst: &PyAny, layer: Option<&str> ) -> PyResult<bool>

Returns true if the graph contains the specified edge

Arguments: src (str or int): the source vertex id dst (str or int): the destination vertex id
layer (str): the edge layer (optional)

Returns: true if the graph contains the specified edge, false otherwise

pub fn vertex(&self, id: &PyAny) -> PyResult<Option<PyVertex>>

Gets the vertex with the specified id

Arguments: id (str or int): the vertex id

Returns: the vertex with the specified id, or None if the vertex does not exist

pub fn vertices(&self) -> PyVertices

Gets the vertices in the graph

Returns: the vertices in the graph

pub fn edge( &self, src: &PyAny, dst: &PyAny, layer: Option<&str> ) -> PyResult<Option<PyEdge>>

Gets the edge with the specified source and destination vertices

Arguments: src (str or int): the source vertex id dst (str or int): the destination vertex id layer (str): the edge layer (optional)

Returns: the edge with the specified source and destination vertices, or None if the edge does not exist

pub fn edges(&self) -> PyEdges

Gets all edges in the graph

Returns: the edges in the graph

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

Returns the default start time for perspectives over the view

Returns: the default start time for perspectives over the view

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

Returns the default start datetime for perspectives over the view

Returns: the default start datetime for perspectives over the view

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

Returns the default end time for perspectives over the view

Returns: the default end time for perspectives over the view

pub fn window_size(&self) -> Option<u64>

Returns the size of the window covered by this view

Returns: int: the size of the window

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

Returns the default end datetime for perspectives over the view

Returns: the default end datetime for perspectives over the view

pub fn window( &self, start: Option<&PyAny>, end: Option<&PyAny> ) -> PyResult<PyGraphView>

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

Arguments: start (int): the start time of the window (optional) end (int): the end time of the window (optional)

Returns: a view including all events between t_start (inclusive) and t_end (exclusive)

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

Create a view including all events until end (inclusive)

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

Returns: a view including all events until end (inclusive)

pub fn default_layer(&self) -> PyGraphView

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

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 __repr__(&self) -> String

Displays the graph

Trait Implementations

impl<G: GraphViewOps + IntoDynamic> From<G> for PyGraphView

Graph view is a read-only version of a graph at a certain point in time.

fn from(value: G) -> Self

Converts to this type from the input type.

impl IntoPy<Py<PyAny>> for PyGraphView

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

Performs the conversion.

impl PyClass for PyGraphView

type Frozen = True

Whether the pyclass is frozen.

impl PyClassImpl for PyGraphView

const DOC: &'static str = _

Class doc string

const IS_BASETYPE: bool = true

#[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<PyGraphView>

Layout

type BaseType = PyAny

Base class

type ThreadChecker = ThreadCheckerStub<PyGraphView>

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForPyGraphView

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

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 PyGraphView

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

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

impl PyTypeInfo for PyGraphView

type AsRefTarget = PyCell<PyGraphView>

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 PyGraphView

fn repr(&self) -> String