Struct Segment 

pub struct Segment {
    pub id: SegmentId,
    pub title: String,
    pub tags: Vec<String>,
    pub text: String,
    pub location: Location,
    pub location_url: Option<String>,
    pub is_included: bool,
    pub last_modification: LastModificationInfo,
}

Fields

id: SegmentId

document-wide unique identifier

title: String

title of this segment

tags: Vec<String>

tags of this segment

text: String

content text of this segment - may be markdown formatted

location: Location

location of this segment

location_url: Option<String>

whether the segment is already included in the output

is_included: bool

url of this location (e.g. in github, etc)

last_modification: LastModificationInfo

last modification info, usually from git

Implementations

impl Segment

pub fn new( id: SegmentId, title: impl Into<String>, tags: Vec<String>, text: impl Into<String>, location: Location, ) -> Segment

Trait Implementations

impl Clone for Segment

fn clone(&self) -> Segment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Segment

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

Formats the value using the given formatter.

impl PartialEq for Segment

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