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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
//! Blocking facade over the async [`Honcho`][crate::Honcho] SDK.
//!
//! Enable with the `blocking` feature flag. Each call drives the underlying
//! async client on a lazily-created internal tokio multi-thread runtime, so
//! users do not need their own runtime.
//!
//! # Errors
//!
//! This facade never panics on its own. If a blocking call is made from inside
//! an active async runtime, it returns
//! [`HonchoError::Configuration`](crate::error::HonchoError) instead. The canonical
//! message is: "blocking API cannot be used from inside an async runtime; use
//! the async Honcho client instead." Use the async [`Honcho`][crate::Honcho]
//! client in that context.
//!
//! # Example
//!
//! ```no_run
//! use honcho_ai::blocking::Honcho;
//!
//! let client = Honcho::new("https://api.honcho.dev", "default")?;
//! let peers = client.peers()?;
//! println!("{} peers", peers.len());
//! # Ok::<(), honcho_ai::error::HonchoError>(())
//! ```
//!
//! # Unnameable builder types (interim)
//!
//! Six public builder types are returned from public methods but are currently
//! **not re-exported** from this module, so they cannot be named in user code
//! (e.g. as a struct field, a function return type, or a rustdoc link). They
//! can still be obtained via the corresponding methods and driven with chained
//! `.build()` calls:
//!
//! | Method | Returned (unnameable) builder |
//! |--------|-------------------------------|
//! | `Peer::chat_stream` | `BlockingChatStreamBuilder` |
//! | `Peer::representation_builder` | `BlockingRepresentationBuilder` |
//! | `Peer::context_builder` | `BlockingContextBuilder` |
//! | `ConclusionScope::representation` | `BlockingConclusionRepresentationBuilder` |
//! | `ConclusionScope::list` | `BlockingListConclusionsBuilder` |
//! | `ConclusionScope::query` | `BlockingQueryConclusionsBuilder` |
//!
//! The re-exports (plus `#![warn(unnameable_types)]` in the crate root) are a
//! breaking change to the public surface and are deferred to a future major
//! release. Until then, store the produced builder inline or factor
//! it through a generic helper rather than naming the type.
pub use Honcho;
pub use ;
pub use ;
pub use ;