Struct OwnedTextDocument 

pub struct OwnedTextDocument {
    pub id: String,
    pub text: String,
    pub language: Option<String>,
    pub timestamp: Option<Timestamp>,
}

Owned text document for storage, serialization, and cross-thread workflows.

Fields

id: String

Stable caller-supplied document id.

text: String

UTF-8 document body.

language: Option<String>

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 OwnedTextDocument

pub fn new(id: impl Into<String>, text: impl Into<String>) -> Self

Creates a new value.

pub fn language(self, language: impl Into<String>) -> Self

Returns language.

pub fn timestamp(self, timestamp: Timestamp) -> Self

Returns timestamp.

pub fn from_segment_id( id: impl Into<String>, segment: &OwnedTextSegment, ) -> Self

Builds this value from segment identifier.

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

Builds this value from stream segment.

pub fn from_owned_stream_segment( stream_id: &str, segment: &OwnedTextSegment, ) -> Self

Builds this value from owned stream segment.

pub fn from_segment( stream_id: impl Into<String>, segment: &OwnedTextSegment, ) -> Self

Builds a document using the supplied stream_id directly as the id.

Prefer OwnedTextDocument::from_segment_id when the id has already been chosen, or OwnedTextDocument::from_owned_stream_segment for the canonical stream_id:segment_index id.

pub fn as_document(&self) -> TextDocument<'_>

Borrows this value as a document.

Trait Implementations

impl Clone for OwnedTextDocument

fn clone(&self) -> OwnedTextDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OwnedTextDocument

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

Formats the value using the given formatter.

impl Eq for OwnedTextDocument

impl From<OwnedTextDocument> for TextDocumentContract

fn from(value: OwnedTextDocument) -> Self

Converts to this type from the input type.

impl IntoTextDocumentContract for OwnedTextDocument

fn into_text_document_contract(self) -> TextDocumentContract

impl IntoTextDocumentContract for &OwnedTextDocument

fn into_text_document_contract(self) -> TextDocumentContract

impl PartialEq for OwnedTextDocument

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