Enum CommentAnchor 

pub enum CommentAnchor {
    Passage {
        path: String,
        start_line: usize,
        end_line: usize,
        quote: String,
        quote_sha256: String,
        section: String,
    },
    DiffLine {
        path: String,
        side: String,
        line: usize,
        quote: String,
    },
    TestLine {
        req: String,
        path: String,
        line: usize,
        quote: String,
    },
    Finding {
        source: String,
        id: String,
        text: String,
    },
}

What an anchored comment points at.

Variants

Passage

A passage of a feature document.

Fields

path: String

Project-relative path.

start_line: usize

First line (1-based).

end_line: usize

Last line.

quote: String

The words selected.

quote_sha256: String

sha256:<hex> of the quote (filled when the draft is stored).

section: String

Its section’s heading path (Requirements › Functional).

DiffLine

A line of the spec’s changes since the last commit.

Fields

path: String

Project-relative path.

side: String

old or new.

line: usize

The line (1-based) on that side.

quote: String

The line’s text.

TestLine

A line of a shown visible test.

Fields

req: String

The requirement.

path: String

The test’s path.

line: usize

The line (1-based).

quote: String

The line’s text.

Finding

A finding the review shows.

Fields

source: String

analyze or review.

id: String

Its id.

text: String

Its text.

Implementations

impl CommentAnchor

pub fn quote(&self) -> &str

The quote the comment is about.

pub fn place(&self) -> String

Where it is, in a few words (spec.md:40-42, US1 tests/a.rs:3).

Trait Implementations

impl Clone for CommentAnchor

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 CommentAnchor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommentAnchor

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CommentAnchor

impl JsonSchema for CommentAnchor

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for CommentAnchor

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CommentAnchor

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 CommentAnchor