Struct rsmgp_sys::memgraph::Memgraph

pub struct Memgraph { /* fields omitted */ }

Main object to interact with Memgraph instance.

Implementations

impl Memgraph

pub fn new(
    args: *const mgp_list,
    graph: *const mgp_graph,
    result: *mut mgp_result,
    memory: *mut mgp_memory,
    module: *mut mgp_module
) -> Memgraph

pub fn new_default() -> Memgraph

Creates a new object with all underlying data set to null. Used for the testing purposes.

pub fn args(&self) -> *const mgp_list

Returns pointer to the object with all arguments passed to the procedure call.

pub fn graph(&self) -> *const mgp_graph

Returns pointer to the object with graph data.

pub fn result(&self) -> *mut mgp_result

Returns pointer to the object where results could be stored.

pub fn memory(&self) -> *mut mgp_memory

Returns pointer to the memory object for advanced memory control.

pub fn module(&self) -> *mut mgp_module

Returns pointer to the module object.

pub fn vertices_iter(&self) -> MgpResult<VerticesIterator>

pub fn vertex_by_id(&self, id: i64) -> MgpResult<Vertex>

pub fn result_record(&self) -> MgpResult<MgpResultRecord>

Creates a new result record.

Keep this object on the stack and add data that will be returned to Memgraph / client during/after the procedure call.

pub fn add_read_procedure(
    &self,
    proc_ptr: extern "C" fn(_: *const mgp_list, _: *const mgp_graph, _: *mut mgp_result, _: *mut mgp_memory),
    name: &CStr,
    result_fields: &[ResultFieldType<'_>]
) -> MgpResult<()>

Registers a new read procedure.

• proc_ptr - Identifier of the top level C function that represents the procedure.
• name - A string that will be registered as a procedure name inside Memgraph instance.
• result_fields - An array of all ResultFieldTypes, each one define by FieldType.

Trait Implementations

impl Clone for Memgraph

fn clone(&self) -> Memgraph

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Memgraph

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

Formats the value using the given formatter.