Struct Notebook

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

A struct that provides an interface for interacting with Urbit notebooks

Fields

channel: &'a mut Channel

Implementations

impl<'a> Notebook<'a>

pub fn export_notebook( &mut self, notebook_ship: &str, notebook_name: &str, ) -> Result<Vec<Note>>

Extracts a Notebook’s graph from the connected ship and parses it into a vector of Notes

pub fn fetch_note( &mut self, notebook_ship: &str, notebook_name: &str, note_index: &str, ) -> Result<Note>

Fetch a note object given an index note_index. This note index can be the root index of the note or any of the child indexes of the note. If a child index for a specific revision of the note is passed then that revision will be fetched, otherwise latest revision is the default.

pub fn fetch_note_with_comment_index( &mut self, notebook_ship: &str, notebook_name: &str, comment_index: &str, ) -> Result<Note>

Fetches the latest version of a note based on providing the index of a comment on said note. This is technically just a wrapper around fetch_note, but is implemented as a separate method to prevent overloading method meaning/documentation thereby preventing confusion.

pub fn fetch_note_latest_revision_index( &mut self, notebook_ship: &str, notebook_name: &str, note_index: &str, ) -> Result<String>

Find the index of the latest revision of a note given an index note_index note_index can be any valid note index (even an index of a comment on the note)

pub fn fetch_comment( &mut self, notebook_ship: &str, notebook_name: &str, comment_index: &str, ) -> Result<Comment>

Fetch a comment given an index comment_index. Index can be the comment root node index, or index of any revision. Will fetch most recent revision if passed root node index

pub fn fetch_comment_latest_revision_index( &mut self, notebook_ship: &str, notebook_name: &str, comment_index: &str, ) -> Result<String>

Fetch index of latest revision of a comment given an index comment_index. Index can be the comment root node index, or the index of any revision of the comment.

pub fn add_note( &mut self, notebook_ship: &str, notebook_name: &str, title: &str, body: &str, ) -> Result<String>

Adds a new note to the notebook. Returns the index of the newly created first revision of the note.

pub fn update_note( &mut self, notebook_ship: &str, notebook_name: &str, note_index: &str, title: &str, body: &str, ) -> Result<String>

Update an existing note with a new title and body. note_index can be any valid note index. Returns index of the newly created revision.

pub fn add_comment( &mut self, notebook_ship: &str, notebook_name: &str, note_index: &str, comment: &NodeContents, ) -> Result<String>

Add a new comment to a specific note inside of a notebook specified by note_index note_index can be any valid note/revision, and even the index of other comments.

pub fn update_comment( &mut self, notebook_ship: &str, notebook_name: &str, comment_index: &str, comment: &NodeContents, ) -> Result<String>

Update an existing comment on a note. comment_index must be a valid index for a comment for a note within the notebook specified which your ship has edit rights for. Returns index of the new comment revision