Skip to main content

HeddleNote

Struct HeddleNote 

Source
pub struct HeddleNote {
    pub state_id: String,
    pub change_id: String,
    pub source_state: Option<State>,
    pub parents_rewritten: bool,
    pub agent: Option<NoteAgent>,
    pub confidence: Option<f32>,
    pub status: String,
    pub omitted_annotations_breakdown: Option<OmittedBreakdown>,
    pub signal_counts: Option<SignalCounts>,
    pub attribution: Option<NoteAttribution>,
}
Expand description

Portable Heddle metadata attached to a projected Git commit.

Fields§

§state_id: String§change_id: String§source_state: Option<State>§parents_rewritten: bool

Whether Git projection changed the parent graph represented by the embedded source state.

§agent: Option<NoteAgent>§confidence: Option<f32>§status: String

Either draft or published.

§omitted_annotations_breakdown: Option<OmittedBreakdown>

Per-scope counts of annotations omitted from a Git export.

§signal_counts: Option<SignalCounts>

Per-module risk-signal counts observed at export time.

§attribution: Option<NoteAttribution>

Author and agent attribution not representable by a Git signature.

Implementations§

Source§

impl HeddleNote

Source

pub fn from_state(state: &State) -> Self

Construct the canonical note for a state projected without rewriting its parent graph.

Source

pub fn from_projected_state(state: &State) -> Self

Construct a note for a Git projection whose parent graph differs from the embedded source state.

Source

pub fn with_omitted_breakdown(self, breakdown: OmittedBreakdown) -> Self

Source

pub fn with_signal_counts(self, counts: SignalCounts) -> Self

Source

pub fn with_attribution(self, attribution: NoteAttribution) -> Self

Source

pub fn to_json_bytes(&self) -> Result<Vec<u8>, Error>

Encode the one canonical JSON representation written to Git notes.

Source

pub fn from_json_bytes(bytes: &[u8]) -> Result<Self, Error>

Decode the canonical Git-note representation.

Trait Implementations§

Source§

impl Clone for HeddleNote

Source§

fn clone(&self) -> HeddleNote

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for HeddleNote

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for HeddleNote

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for HeddleNote

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for HeddleNote

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for HeddleNote

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.