Struct PyGraphRecord 

pub struct PyGraphRecord { /* private fields */ }

Implementations

impl PyGraphRecord

pub fn scope<R>( py: Python<'_>, graphrecord: &mut PluginGraphRecord, function: impl FnOnce(Python<'_>, &Py<Self>) -> GraphRecordResult<R>, ) -> GraphRecordResult<R>

Safely pass a &mut PluginGraphRecord to Python as a PyGraphRecord for the duration of the callback. The pointer is invalidated when function returns.

Based on the discussion in:

• https://github.com/PyO3/pyo3/issues/1180

Guard pattern adapted from:

• https://github.com/PyO3/pyo3/issues/1180#issuecomment-692898577

impl PyGraphRecord

pub fn new() -> Self

pub fn _to_bytes<'py>(&self, py: Python<'py>) -> PyResult<Bound<'py, PyBytes>>

pub fn _from_bytes(data: &Bound<'_, PyBytes>) -> PyResult<Self>

pub fn with_schema(schema: PySchema) -> Self

pub fn with_plugins(plugins: Vec<Py<PyAny>>) -> PyResult<Self>

pub fn from_tuples( nodes: Vec<(PyNodeIndex, PyAttributes)>, edges: Option<Vec<(PyNodeIndex, PyNodeIndex, PyAttributes)>>, ) -> PyResult<Self>

pub fn from_dataframes( nodes_dataframes: Vec<(PyDataFrame, String)>, edges_dataframes: Vec<(PyDataFrame, String, String)>, ) -> PyResult<Self>

pub fn from_nodes_dataframes( nodes_dataframes: Vec<(PyDataFrame, String)>, ) -> PyResult<Self>

pub fn from_ron(path: &str) -> PyResult<Self>

pub fn to_ron(&self, path: &str) -> PyResult<()>

pub fn to_dataframes(&self, py: Python<'_>) -> PyResult<Py<PyAny>>

pub fn get_schema(&self) -> PyResult<PySchema>

pub fn set_schema(&self, schema: PySchema, bypass_plugins: bool) -> PyResult<()>

pub fn freeze_schema(&self, bypass_plugins: bool) -> PyResult<()>

pub fn unfreeze_schema(&self, bypass_plugins: bool) -> PyResult<()>

pub fn nodes(&self) -> PyResult<Vec<PyNodeIndex>>

pub fn node( &self, node_index: Vec<PyNodeIndex>, ) -> PyResult<HashMap<PyNodeIndex, PyAttributes>>

pub fn edges(&self) -> PyResult<Vec<EdgeIndex>>

pub fn edge( &self, edge_index: Vec<EdgeIndex>, ) -> PyResult<HashMap<EdgeIndex, PyAttributes>>

pub fn groups(&self) -> PyResult<Vec<PyGroup>>

pub fn outgoing_edges( &self, node_index: Vec<PyNodeIndex>, ) -> PyResult<HashMap<PyNodeIndex, Vec<EdgeIndex>>>

pub fn incoming_edges( &self, node_index: Vec<PyNodeIndex>, ) -> PyResult<HashMap<PyNodeIndex, Vec<EdgeIndex>>>

pub fn edge_endpoints( &self, edge_index: Vec<EdgeIndex>, ) -> PyResult<HashMap<EdgeIndex, (PyNodeIndex, PyNodeIndex)>>

pub fn edges_connecting( &self, source_node_indices: Vec<PyNodeIndex>, target_node_indices: Vec<PyNodeIndex>, ) -> PyResult<Vec<EdgeIndex>>

pub fn edges_connecting_undirected( &self, first_node_indices: Vec<PyNodeIndex>, second_node_indices: Vec<PyNodeIndex>, ) -> PyResult<Vec<EdgeIndex>>

pub fn remove_nodes( &self, node_indices: Vec<PyNodeIndex>, bypass_plugins: bool, ) -> PyResult<HashMap<PyNodeIndex, PyAttributes>>

pub fn replace_node_attributes( &self, node_indices: Vec<PyNodeIndex>, attributes: PyAttributes, ) -> PyResult<()>

pub fn update_node_attribute( &self, node_indices: Vec<PyNodeIndex>, attribute: PyGraphRecordAttribute, value: PyGraphRecordValue, ) -> PyResult<()>

pub fn remove_node_attribute( &self, node_indices: Vec<PyNodeIndex>, attribute: PyGraphRecordAttribute, ) -> PyResult<()>

pub fn add_nodes( &self, nodes: Vec<(PyNodeIndex, PyAttributes)>, bypass_plugins: bool, ) -> PyResult<()>

pub fn add_nodes_with_group( &self, nodes: Vec<(PyNodeIndex, PyAttributes)>, group: PyGroup, bypass_plugins: bool, ) -> PyResult<()>

pub fn add_nodes_dataframes( &self, nodes_dataframes: Vec<(PyDataFrame, String)>, bypass_plugins: bool, ) -> PyResult<()>

pub fn add_nodes_dataframes_with_group( &self, nodes_dataframes: Vec<(PyDataFrame, String)>, group: PyGroup, bypass_plugins: bool, ) -> PyResult<()>

pub fn remove_edges( &self, edge_indices: Vec<EdgeIndex>, bypass_plugins: bool, ) -> PyResult<HashMap<EdgeIndex, PyAttributes>>

pub fn replace_edge_attributes( &self, edge_indices: Vec<EdgeIndex>, attributes: PyAttributes, ) -> PyResult<()>

pub fn update_edge_attribute( &self, edge_indices: Vec<EdgeIndex>, attribute: PyGraphRecordAttribute, value: PyGraphRecordValue, ) -> PyResult<()>

pub fn remove_edge_attribute( &self, edge_indices: Vec<EdgeIndex>, attribute: PyGraphRecordAttribute, ) -> PyResult<()>

pub fn add_edges( &self, relations: Vec<(PyNodeIndex, PyNodeIndex, PyAttributes)>, bypass_plugins: bool, ) -> PyResult<Vec<EdgeIndex>>

pub fn add_edges_with_group( &self, relations: Vec<(PyNodeIndex, PyNodeIndex, PyAttributes)>, group: PyGroup, bypass_plugins: bool, ) -> PyResult<Vec<EdgeIndex>>

pub fn add_edges_dataframes( &self, edges_dataframes: Vec<(PyDataFrame, String, String)>, bypass_plugins: bool, ) -> PyResult<Vec<EdgeIndex>>

pub fn add_edges_dataframes_with_group( &self, edges_dataframes: Vec<(PyDataFrame, String, String)>, group: PyGroup, bypass_plugins: bool, ) -> PyResult<Vec<EdgeIndex>>

pub fn add_group( &self, group: PyGroup, node_indices_to_add: Option<Vec<PyNodeIndex>>, edge_indices_to_add: Option<Vec<EdgeIndex>>, bypass_plugins: bool, ) -> PyResult<()>

pub fn remove_groups( &self, group: Vec<PyGroup>, bypass_plugins: bool, ) -> PyResult<()>

pub fn add_nodes_to_group( &self, group: PyGroup, node_index: Vec<PyNodeIndex>, bypass_plugins: bool, ) -> PyResult<()>

pub fn add_edges_to_group( &self, group: PyGroup, edge_index: Vec<EdgeIndex>, bypass_plugins: bool, ) -> PyResult<()>

pub fn remove_nodes_from_group( &self, group: PyGroup, node_index: Vec<PyNodeIndex>, bypass_plugins: bool, ) -> PyResult<()>

pub fn remove_edges_from_group( &self, group: PyGroup, edge_index: Vec<EdgeIndex>, bypass_plugins: bool, ) -> PyResult<()>

pub fn nodes_in_group( &self, group: Vec<PyGroup>, ) -> PyResult<HashMap<PyGroup, Vec<PyNodeIndex>>>

pub fn ungrouped_nodes(&self) -> PyResult<Vec<PyNodeIndex>>

pub fn edges_in_group( &self, group: Vec<PyGroup>, ) -> PyResult<HashMap<PyGroup, Vec<EdgeIndex>>>

pub fn ungrouped_edges(&self) -> PyResult<Vec<EdgeIndex>>

pub fn groups_of_node( &self, node_index: Vec<PyNodeIndex>, ) -> PyResult<HashMap<PyNodeIndex, Vec<PyGroup>>>

pub fn groups_of_edge( &self, edge_index: Vec<EdgeIndex>, ) -> PyResult<HashMap<EdgeIndex, Vec<PyGroup>>>

pub fn node_count(&self) -> PyResult<usize>

pub fn edge_count(&self) -> PyResult<usize>

pub fn group_count(&self) -> PyResult<usize>

pub fn contains_node(&self, node_index: PyNodeIndex) -> PyResult<bool>

pub fn contains_edge(&self, edge_index: EdgeIndex) -> PyResult<bool>

pub fn contains_group(&self, group: PyGroup) -> PyResult<bool>

pub fn neighbors( &self, node_indices: Vec<PyNodeIndex>, ) -> PyResult<HashMap<PyNodeIndex, Vec<PyNodeIndex>>>

pub fn neighbors_undirected( &self, node_indices: Vec<PyNodeIndex>, ) -> PyResult<HashMap<PyNodeIndex, Vec<PyNodeIndex>>>

pub fn clear(&self, bypass_plugins: bool) -> PyResult<()>

pub fn query_nodes( &self, py: Python<'_>, query: &Bound<'_, PyFunction>, ) -> PyResult<Py<PyAny>>

Panics

Panics if the python typing was not followed.

pub fn query_edges( &self, py: Python<'_>, query: &Bound<'_, PyFunction>, ) -> PyResult<Py<PyAny>>

Panics

Panics if the python typing was not followed.

pub fn clone(&self) -> Self

pub fn overview(&self, truncate_details: Option<usize>) -> PyResult<PyOverview>

pub fn group_overview( &self, group: PyGroup, truncate_details: Option<usize>, ) -> PyResult<PyGroupOverview>

Trait Implementations

impl Clone for PyGraphRecord

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PyGraphRecord

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

Formats the value using the given formatter.

impl From<GraphRecord> for PyGraphRecord

fn from(value: GraphRecord) -> Self

Converts to this type from the input type.

impl From<PluginGraphRecord> for PyGraphRecord

fn from(value: PluginGraphRecord) -> Self

Converts to this type from the input type.

impl<'py> IntoPyObject<'py> for PyGraphRecord

type Target = PyGraphRecord

The Python output type

type Output = Bound<'py, <PyGraphRecord as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for PyGraphRecord

type Frozen = True

Whether the pyclass is frozen.

impl PyClassImpl for PyGraphRecord

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)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = c"\x00"

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<PyGraphRecord>

This handles following two situations:

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 PyClassNewTextSignature for PyGraphRecord

const TEXT_SIGNATURE: &'static str = "()"

impl PyMethods<PyGraphRecord> for PyClassImplCollector<PyGraphRecord>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyGraphRecord

const NAME: &'static str = "PyGraphRecord"

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<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

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

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl TryFrom<PyGraphRecord> for GraphRecord

type Error = PyErr

The type returned in the event of a conversion error.

fn try_from(value: PyGraphRecord) -> PyResult<Self>

Performs the conversion.

impl DerefToPyAny for PyGraphRecord

impl ExtractPyClassWithClone for PyGraphRecord