Struct Text 

#[non_exhaustive]
pub struct Text {
    pub text: String,
    pub native: Option<Native>,
    /* private fields */
}

Text. On an assistant turn, native holds the provider item the block was decoded from, and Text::citations what the provider says supports it; user and tool-result text leave both empty.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

text: String

Text content.

native: Option<Native>

The provider item this block was decoded from.

Implementations

impl Text

pub fn citations(&self) -> &[Citation]

The citations, while text is what they were resolved against; empty once it has been edited.

pub fn with_citations( self, citations: impl IntoIterator<Item = Citation>, ) -> Self

This text with citations, bound to its current text. A citation whose span is off a character boundary or past the end is dropped with a warning.

pub fn clear_citations(&mut self)

Remove every citation.

pub fn cited(&self, citation: &Citation) -> Option<&str>

The text citation covers: its span, or the whole block. It reads any citation against the current text and does not check that the citation belongs to it, so a citation kept from before an edit gives whatever text now sits at its span, or None past the end. Read citations through Text::citations, which hides them once the text changes.

pub fn span(&self, range: Range<usize>) -> Option<Span>

A span over range, in bytes of this text; None when either end is off a character boundary or past the end, or range is reversed.

impl Text

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

Text with no provider item and no citations.

pub fn text(&self) -> &str

Returns the inner text string.

Trait Implementations

impl Clone for Text

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 Text

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

Formats the value using the given formatter.

impl Default for Text

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Text

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Text

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

Formats the value using the given formatter.

impl From<&String> for Text

fn from(text: &String) -> Self

Converts to this type from the input type.

impl From<&str> for Text

fn from(text: &str) -> Self

Converts to this type from the input type.

impl From<String> for Text

fn from(text: String) -> Self

Converts to this type from the input type.

impl From<Text> for Message

fn from(value: Text) -> Self

Converts to this type from the input type.

impl FromStr for Text

type Err = !

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Text

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Text

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 Text