rune-chain-core 0.1.1

Core traits and types for the rune-chain LLM orchestration framework
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

use serde::{Deserialize, Serialize};

/// A single chunk delivered by a streaming LLM response.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct StreamData {
    /// The partial text content of this chunk.
    pub content: String,
    /// `true` for the final chunk; after this the stream ends.
    pub is_finished: bool,
}

impl StreamData {
    /// Create a non-terminal chunk carrying the given text fragment.
    ///
    /// # Example
    ///
    /// ```rust
    /// use rune_chain_core::StreamData;
    ///
    /// let chunk = StreamData::chunk("Hello");
    /// assert_eq!(chunk.content, "Hello");
    /// assert!(!chunk.is_finished);
    /// ```
    pub fn chunk(content: impl Into<String>) -> Self {
        Self {
            content: content.into(),
            is_finished: false,
        }
    }

    /// Create the terminal chunk signalling the end of the stream.
    ///
    /// # Example
    ///
    /// ```rust
    /// use rune_chain_core::StreamData;
    ///
    /// let done = StreamData::done();
    /// assert!(done.is_finished);
    /// assert!(done.content.is_empty());
    /// ```
    pub fn done() -> Self {
        Self {
            content: String::new(),
            is_finished: true,
        }
    }
}