Struct Note 

pub struct Note { /* private fields */ }

Represents a user note attached to a PackFile or a specific file within it.

Notes provide a way for users to annotate their work, leave reminders, or document specific files or aspects of their PackFile modifications.

Examples

Creating a global note:

let note = Note {
    id: 1,
    message: "Remember to test this before release".to_string(),
    url: None,
    path: String::new(),  // Empty path = global note
};

Creating a path-specific note:

let note = Note {
    id: 2,
    message: "This table needs balancing".to_string(),
    url: Some("https://wiki.example.com/balance".to_string()),
    path: "db/units_tables/core_units".to_string(),
};

Implementations

impl Note

pub fn id(&self) -> &u64

Unique identifier for this note.

Used to distinguish between different notes and for referencing specific notes.

pub fn message(&self) -> &String

The main content/body of the note.

Contains the user’s message, reminder, or documentation text.

pub fn url(&self) -> &Option<String>

Optional URL associated with the note.

Can be used to link to external documentation, wiki pages, issue trackers, etc.

pub fn path(&self) -> &String

Path within the PackFile where this note applies.

• Empty string: Global note that applies to the entire PackFile
• Non-empty: Path to a specific file (e.g., "db/units_tables/core_units")

impl Note

pub fn set_id(&mut self, val: u64) -> &mut Self

Unique identifier for this note.

Used to distinguish between different notes and for referencing specific notes.

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

The main content/body of the note.

Contains the user’s message, reminder, or documentation text.

pub fn set_url(&mut self, val: Option<String>) -> &mut Self

Optional URL associated with the note.

Can be used to link to external documentation, wiki pages, issue trackers, etc.

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

Path within the PackFile where this note applies.

• Empty string: Global note that applies to the entire PackFile
• Non-empty: Path to a specific file (e.g., "db/units_tables/core_units")

Trait Implementations

impl Clone for Note

fn clone(&self) -> Note

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Note

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

Formats the value using the given formatter.

impl Default for Note

fn default() -> Note

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Note

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Note

fn eq(&self, other: &Note) -> 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 Note

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 Note

impl StructuralPartialEq for Note