Struct Note 

pub struct Note {
    pub title: String,
    pub text: String,
}

A note in a transcript: an Aside of kind Note::KIND that every front showing the conversation draws after the entry it follows, with what it shows collapsed, in a line, and what it shows expanded. It never reaches a model, and it is saved, restored and forked with the conversation; one made unsaved is not saved.

use rig_core::conversation::{Author, Conversation, Note};
use rig_core::message::Message;

let mut conversation = Conversation::new();
conversation.push(Message::user("Why tabs?"));
let after = conversation.id(0);
let note = Note::new("Why tabs?", "The project's style says so.");
conversation.add_aside(note.aside(Author::plugin("btw"), after));

Fields

title: String

What it shows collapsed, in a line.

text: String

What it shows expanded.

Implementations

impl Note

pub const KIND: &'static str = "note"

The kind of the asides that hold a note.

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

A note titled title, showing text expanded.

pub fn aside(self, author: Author, after: Option<MessageId>) -> Aside

The saved aside by author that holds this note, following the entry after (None: before the first).

pub fn of(aside: &Aside) -> Option<Self>

The note aside holds, when it holds one.

Trait Implementations

impl Clone for Note

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 Note

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Note

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Note

impl PartialEq for Note

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Note

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 Note