Struct PackNotes 

pub struct PackNotes { /* private fields */ }

Pack notes for documentation and collaboration.

Notes are stored within the pack and include both pack-level notes (general documentation) and file-specific notes (annotations on individual files or tables). Notes are serialized as JSON and can be shared when the pack is distributed.

Implementations

impl PackNotes

pub fn pack_notes(&self) -> &String

General notes for the entire pack (Markdown format).

pub fn file_notes(&self) -> &HashMap<String, Vec<Note>>

File-specific notes, keyed by lowercase file path.

For DB tables, notes are shared across all tables of the same type (path is truncated to db/table_name/).

impl PackNotes

pub fn pack_notes_mut(&mut self) -> &mut String

General notes for the entire pack (Markdown format).

pub fn file_notes_mut(&mut self) -> &mut HashMap<String, Vec<Note>>

File-specific notes, keyed by lowercase file path.

For DB tables, notes are shared across all tables of the same type (path is truncated to db/table_name/).

impl PackNotes

pub fn set_pack_notes(&mut self, val: String) -> &mut Self

General notes for the entire pack (Markdown format).

pub fn set_file_notes(&mut self, val: HashMap<String, Vec<Note>>) -> &mut Self

File-specific notes, keyed by lowercase file path.

For DB tables, notes are shared across all tables of the same type (path is truncated to db/table_name/).

impl PackNotes

pub fn load(data: &[u8]) -> Result<Self>

This function tries to load the notes from the current Pack and return them.

pub fn notes_by_path(&self, path: &str) -> Vec<Note>

This function returns all notes afecting the provided path.

pub fn add_note(&mut self, note: Note) -> Note

This function adds a note for an specific path.

Note: for DB tables, notes are added for all tables with the same table name instead of specific tables.

pub fn delete_note(&mut self, path: &str, id: u64)

This function deletes a note with the specified path and id.

Trait Implementations

impl Clone for PackNotes

fn clone(&self) -> PackNotes

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PackNotes

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

Formats the value using the given formatter.

impl Default for PackNotes

fn default() -> PackNotes

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PackNotes

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PackNotes

fn eq(&self, other: &PackNotes) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PackNotes

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PackNotes

impl StructuralPartialEq for PackNotes