Struct ToolkitService

Source
pub struct ToolkitService { /* private fields */ }
Expand description

A service that manages and runs a Toolkit.

§Example

let mut service = ToolkitService::new("UNIFAI_TOOLKIT_API_KEY");

let info = ToolkitInfo {
    name: "Echo Slam".to_string(),
    description: "What's in, what's out.".to_string(),
};

service.update_info(info).await.unwrap();

service.add_action(EchoSlam);

let runner = service.start().await.unwrap();
let _ = runner.await.unwrap();

Implementations§

Source§

impl ToolkitService

Source

pub fn new(api_key: &str) -> Self

Create a Toolkit service with Unifai API Key.

Examples found in repository?
examples/echo_toolkit.rs (line 70)
64async fn main() {
65    tracing_subscriber::fmt().init();
66
67    let unifai_toolkit_api_key =
68        env::var("UNIFAI_TOOLKIT_API_KEY").expect("UNIFAI_TOOLKIT_API_KEY not set");
69
70    let mut service = ToolkitService::new(&unifai_toolkit_api_key);
71
72    let info = ToolkitInfo {
73        name: "Echo Slam".to_string(),
74        description: "What's in, what's out.".to_string(),
75    };
76
77    service.update_info(info).await.unwrap();
78
79    service.add_action(EchoSlam);
80
81    let runner = service.start().await.unwrap();
82    let _ = runner.await.unwrap();
83}
Source

pub async fn update_info(&self, info: ToolkitInfo) -> Result<(), ToolkitError>

Update Toolkit’s name and description.

Examples found in repository?
examples/echo_toolkit.rs (line 77)
64async fn main() {
65    tracing_subscriber::fmt().init();
66
67    let unifai_toolkit_api_key =
68        env::var("UNIFAI_TOOLKIT_API_KEY").expect("UNIFAI_TOOLKIT_API_KEY not set");
69
70    let mut service = ToolkitService::new(&unifai_toolkit_api_key);
71
72    let info = ToolkitInfo {
73        name: "Echo Slam".to_string(),
74        description: "What's in, what's out.".to_string(),
75    };
76
77    service.update_info(info).await.unwrap();
78
79    service.add_action(EchoSlam);
80
81    let runner = service.start().await.unwrap();
82    let _ = runner.await.unwrap();
83}
Source

pub fn add_action(&mut self, action: impl Action + 'static)

Add an action that implements the Action trait to be registered when starting.

Examples found in repository?
examples/echo_toolkit.rs (line 79)
64async fn main() {
65    tracing_subscriber::fmt().init();
66
67    let unifai_toolkit_api_key =
68        env::var("UNIFAI_TOOLKIT_API_KEY").expect("UNIFAI_TOOLKIT_API_KEY not set");
69
70    let mut service = ToolkitService::new(&unifai_toolkit_api_key);
71
72    let info = ToolkitInfo {
73        name: "Echo Slam".to_string(),
74        description: "What's in, what's out.".to_string(),
75    };
76
77    service.update_info(info).await.unwrap();
78
79    service.add_action(EchoSlam);
80
81    let runner = service.start().await.unwrap();
82    let _ = runner.await.unwrap();
83}
Source

pub async fn start( self, ) -> Result<JoinHandle<Result<(), ToolkitError>>, ToolkitError>

Start the Toolkit service asynchronously.

Once the service is ready, it returns a JoinHandle that keeps the service alive.

Examples found in repository?
examples/echo_toolkit.rs (line 81)
64async fn main() {
65    tracing_subscriber::fmt().init();
66
67    let unifai_toolkit_api_key =
68        env::var("UNIFAI_TOOLKIT_API_KEY").expect("UNIFAI_TOOLKIT_API_KEY not set");
69
70    let mut service = ToolkitService::new(&unifai_toolkit_api_key);
71
72    let info = ToolkitInfo {
73        name: "Echo Slam".to_string(),
74        description: "What's in, what's out.".to_string(),
75    };
76
77    service.update_info(info).await.unwrap();
78
79    service.add_action(EchoSlam);
80
81    let runner = service.start().await.unwrap();
82    let _ = runner.await.unwrap();
83}

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,