Struct Note 

pub struct Note {
    pub id: ObjectHash,
    pub target_object_id: ObjectHash,
    pub content: String,
}

Git Note object structure

A Note represents additional metadata attached to a Git object (typically a commit). The Note itself is stored as a Blob object in Git’s object database, with the association managed through Git’s reference system.

Fields

id: ObjectHash

The ObjectHash of this Note object (same as the underlying Blob)

target_object_id: ObjectHash

The ObjectHash of the object this Note annotates (usually a commit)

content: String

The textual content of the Note

Implementations

impl Note

pub fn new(target_object_id: ObjectHash, content: String) -> Self

Create a new Note for the specified target object with the given content

Arguments

• target_object_id - The ObjectHash of the object to annotate
• content - The textual content of the note

Returns

A new Note instance with calculated ID based on the content

pub fn from_content(content: &str) -> Self

Create a Note from content string, with default target object

This is a convenience method for creating Notes when the target will be set later by the notes management system.

Arguments

• content - The textual content of the note

Returns

A new Note instance with default target object ID

pub fn content_size(&self) -> usize

Get the size of the Note content in bytes

pub fn is_empty(&self) -> bool

Check if the Note is empty (has no content)

pub fn set_target(&mut self, new_target: ObjectHash)

Update the target object ID for this Note

This method allows changing which object this Note annotates without changing the Note’s content or ID.

Arguments

• new_target - The new target object SHA-1/ SHA-256 hash

pub fn from_bytes_with_target( data: &[u8], hash: ObjectHash, target_object_id: ObjectHash, ) -> Result<Self, GitError>

Create a Note object from raw bytes with explicit target object ID

This is the preferred method when you know both the content and the target object, as it preserves the complete Note association information.

Arguments

• data - The raw byte data (UTF-8 encoded text content)
• hash - The SHA-1/ SHA-256 hash of this Note object
• target_object_id - The SHA-1/ SHA-256 hash of the object this Note annotates

Returns

A Result containing the Note object with complete association info

pub fn to_data_with_target(&self) -> Result<(Vec<u8>, ObjectHash), GitError>

Serialize a Note with its target association for external storage

This method returns both the Git object data and the target object ID, which can be used by higher-level systems to manage the refs/notes/* references.

Returns

A tuple of (object_data, target_object_id)

Trait Implementations

impl Archive for Note

where ObjectHash: Archive, String: Archive,

const COPY_OPTIMIZATION: CopyOptimization<Self>

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize.

type Archived = ArchivedNote

The archived representation of this type.

type Resolver = NoteResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

fn resolve(&self, resolver: Self::Resolver, out: Place<Self::Archived>)

Creates the archived version of this value at the given position and writes it to the given output.

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<'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<__D: Fallible + ?Sized> Deserialize<Note, __D> for Archived<Note>

where ObjectHash: Archive, <ObjectHash as Archive>::Archived: Deserialize<ObjectHash, __D>, String: Archive, <String as Archive>::Archived: Deserialize<String, __D>,

fn deserialize( &self, deserializer: &mut __D, ) -> Result<Note, <__D as Fallible>::Error>

Deserializes using the given deserializer

impl Display for Note

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

Formats the value using the given formatter.

impl ObjectTrait for Note

fn from_bytes(data: &[u8], hash: ObjectHash) -> Result<Self, GitError>

where Self: Sized,

Create a Note object from raw bytes and hash

Arguments

• data - The raw byte data (UTF-8 encoded text content)
• hash - The SHA-1/ SHA-256 hash of this Note object

Returns

A Result containing the Note object or an error

fn get_type(&self) -> ObjectType

Get the Git object type for Notes

Notes are stored as Blob objects in Git’s object database

fn get_size(&self) -> usize

Get the size of the Note content

fn to_data(&self) -> Result<Vec<u8>, GitError>

Convert the Note to raw byte data for storage

Returns

A Result containing the byte representation or an error

fn from_buf_read<R: BufRead>(read: &mut ReadBoxed<R>, size: usize) -> Self

where Self: Sized,

Generate a new Object from a ReadBoxed<BufRead>. the input size,is only for new a vec with directive space allocation the input data stream and output object should be plain base object .

fn object_hash(&self) -> Result<ObjectHash, GitError>

impl PartialEq for Note

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

Two Notes are equal if they have the same ID

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<__S: Fallible + ?Sized> Serialize<__S> for Note

where ObjectHash: Serialize<__S>, String: Serialize<__S>,

fn serialize( &self, serializer: &mut __S, ) -> Result<<Self as Archive>::Resolver, <__S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

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