Struct urbit_http_api::graphstore::GraphStore

pub struct GraphStore<'a> {
    pub channel: &'a mut Channel,
}

A struct which exposes Graph Store functionality

Fields

channel: &'a mut Channel

Implementations

impl<'a> GraphStore<'a>

pub fn new_node(&self, contents: &NodeContents) -> Node

Create a new Graph Store node using defaults from the connected ship and local time. This is a wrapper method around Node::new() which fills out a lot of boilerplate.

pub fn new_node_specified(
    &self,
    node_index: &str,
    unix_time: u64,
    contents: &NodeContents
) -> Node

Create a new Graph Store node using a specified index and creation time using the connected ship as author

pub fn add_node(
    &mut self,
    resource_ship: &str,
    resource_name: &str,
    node: &Node
) -> Result<()>

Add node to Graph Store

pub fn add_node_spider(
    &mut self,
    resource_ship: &str,
    resource_name: &str,
    node: &Node
) -> Result<()>

Add node to Graph Store via spider thread

pub fn remove_nodes(
    &mut self,
    resource_ship: &str,
    resource_name: &str,
    indices: Vec<&str>
) -> Result<()>

Remove nodes from Graph Store using the provided list of indices

pub fn get_node(
    &mut self,
    resource_ship: &str,
    resource_name: &str,
    node_index: &str
) -> Result<Node>

Acquire a node from Graph Store

pub fn get_node_subset(
    &mut self,
    resource_ship: &str,
    resource_name: &str,
    node_index: &str,
    start_index: &str,
    end_index: &str
) -> Result<Graph>

Acquire a subset of children of a node from Graph Store by specifying the start and end indices of the subset children.

pub fn create_managed_graph(
    &mut self,
    graph_resource_name: &str,
    graph_title: &str,
    graph_description: &str,
    graph_module: Module,
    managed_group_ship: &str,
    managed_group_name: &str
) -> Result<()>

Create a new graph on the connected Urbit ship that is managed (meaning associated with a specific group)

pub fn create_unmanaged_graph(
    &mut self,
    graph_resource_name: &str,
    graph_title: &str,
    graph_description: &str,
    graph_module: Module
) -> Result<()>

Create a new graph on the connected Urbit ship that is unmanaged (meaning not associated with any group)

pub fn get_graph(
    &mut self,
    resource_ship: &str,
    resource_name: &str
) -> Result<Graph>

Acquire a graph from Graph Store

pub fn get_graph_subset(
    &mut self,
    resource_ship: &str,
    resource_name: &str,
    start_index: &str,
    end_index: &str
) -> Result<Graph>

Acquire a subset of a graph from Graph Store by specifying the start and end indices of the subset of the graph.

pub fn delete_graph(
    &mut self,
    resource_ship: &str,
    resource_name: &str
) -> Result<()>

Delete graph from Graph Store

pub fn leave_graph(
    &mut self,
    resource_ship: &str,
    resource_name: &str
) -> Result<()>

Leave graph in Graph Store

pub fn archive_graph(
    &mut self,
    resource_ship: &str,
    resource_name: &str
) -> Result<String>

Archive a graph in Graph Store

pub fn unarchive_graph(
    &mut self,
    resource_ship: &str,
    resource_name: &str
) -> Result<String>

Unarchive a graph in Graph Store

pub fn add_tag(
    &mut self,
    resource_ship: &str,
    resource_name: &str,
    tag: &str
) -> Result<()>

Add a tag to a graph

pub fn remove_tag(
    &mut self,
    resource_ship: &str,
    resource_name: &str,
    tag: &str
) -> Result<()>

Remove a tag from a graph

pub fn get_keys(&mut self) -> Result<Vec<JsonValue>>

Performs a scry to get all keys

pub fn get_tags(&mut self) -> Result<Vec<JsonValue>>

Performs a scry to get all tags

pub fn get_tag_queries(&mut self) -> Result<Vec<JsonValue>>

Performs a scry to get all tags

pub fn peek_update_log(
    &mut self,
    resource_ship: &str,
    resource_name: &str
) -> Result<String>

Acquire the time the update log of a given resource was last updated

pub fn get_update_log(
    &mut self,
    resource_ship: &str,
    resource_name: &str
) -> Result<String>

Acquire the update log for a given resource

pub fn get_update_log_subset(
    &mut self,
    resource_ship: &str,
    resource_name: &str,
    start_index: &str,
    end_index: &str
) -> Result<String>

Acquire a subset of the update log for a given resource