Struct Segment 

pub struct Segment {
    pub schema: SegmentsSchema,
    pub kind: SegmentKind,
    pub start: u64,
    pub end: u64,
    pub unit: String,
    pub source: Option<String>,
    pub name: Option<String>,
    pub hidden: bool,
}

One record of a segments file.

Fields

schema: SegmentsSchema

The literal string text-mirror/segments@1, always first.

kind: SegmentKind

Record kind. Boundary kinds are zero-width.

start: u64

Start offset into the artifact, in UTF-8 bytes.

end: u64

End offset, exclusive. Equal to start for a boundary.

unit: String

The offset unit, the literal utf8_bytes.

source: Option<String>

The source structure a span maps to, such as document, sheet, row, or column.

name: Option<String>

Structure name, such as a sheet name.

hidden: bool

True when the covered content was hidden in the source.

Implementations

impl Segment

pub fn span(start: usize, end: usize, source: &str) -> Segment

A content span over start..end.

pub fn boundary(kind: SegmentKind, at: usize) -> Segment

A zero-width boundary at at.

pub fn named(self, name: &str) -> Segment

The same segment with a name attached.

pub fn hidden(self) -> Segment

The same segment marked hidden.

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<'de> Deserialize<'de> for Segment

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Segment

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Segment

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 Segment