Struct TextDocument 

pub struct TextDocument<'a> {
    pub id: &'a str,
    pub text: &'a str,
    pub language: Option<&'a str>,
    pub timestamp: Option<Timestamp>,
}

Borrowed text document used as the lightweight boundary between text crates.

Fields

id: &'a str

Stable caller-supplied document id.

text: &'a str

UTF-8 document body.

language: Option<&'a str>

Optional BCP-47-style language hint such as en.

timestamp: Option<Timestamp>

Optional media timestamp when this document came from a timed segment.

Implementations

impl<'a> TextDocument<'a>

pub fn new(id: &'a str, text: &'a str) -> Self

Creates a new value.

pub fn from_segment_id(id: &'a str, segment: &TextSegment<'a>) -> Self

Builds this value from segment identifier.

pub fn from_stream_segment( stream_id: &str, segment: &TextSegment<'_>, ) -> OwnedTextDocument

Builds this value from stream segment.

pub fn from_segment(stream_id: &'a str, segment: &TextSegment<'a>) -> Self

Builds a document using stream_id directly as the document id.

Prefer TextDocument::from_segment_id when the id has already been chosen, or TextDocument::from_stream_segment when converting a stream segment into the canonical stream_id:segment_index id.

Trait Implementations

impl<'a> Clone for TextDocument<'a>

fn clone(&self) -> TextDocument<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for TextDocument<'a>

impl<'a> Debug for TextDocument<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for TextDocument<'a>

impl From<TextDocument<'_>> for TextDocumentContract

fn from(value: TextDocument<'_>) -> Self

Converts to this type from the input type.

impl IntoTextDocumentContract for TextDocument<'_>

fn into_text_document_contract(self) -> TextDocumentContract

impl<'a> PartialEq for TextDocument<'a>

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