Struct Note 

pub struct Note {
    pub path: String,
    pub side: NoteSide,
    pub line: usize,
    pub code: String,
    pub text: String,
    pub review: Option<String>,
    pub draft: bool,
}

A reviewer’s note on one line of a change, or — with an empty path — on the change as a whole.

Fields

path: String

side: NoteSide

line: usize

code: String

The line the note is about, so the note still makes sense once lines move.

text: String

review: Option<String>

The review the note was left in — a pull request, or a range such as origin/main...feature — so it only shows up, and is only posted, there.

draft: bool

Added from outside the viewer (declutter notes add) and not yet opened by the reviewer. Drafts are never posted: opening one with m makes it the reviewer’s.

Implementations

impl Note

pub fn on_pull_request(text: impl Into<String>) -> Note

A draft note on the change as a whole rather than on a line.

pub fn on_line( files: &[FileReview], path: &str, side: NoteSide, line: usize, text: impl Into<String>, ) -> Result<Note>

A draft note on line of path, which must be a row of the change’s diff — with every layer shown — since that is where the viewer can show it. A removed line is on the old side; added and unchanged lines are on the new side.

pub fn is_general(&self) -> bool

pub fn place(&self) -> String

“Cart.swift:12”, or “Cart.swift (removed line 12)”.

Trait Implementations

impl Clone for Note

fn clone(&self) -> Self

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 Eq for Note

impl PartialEq for Note

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

Equality operator ==.

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

Inequality operator !=.

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 StructuralPartialEq for Note