Skip to main content

Caster

Struct Caster 

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

Caster connects to a Rune Runtime and registers Rune handlers.

Implementations§

Source§

impl Caster

Source

pub fn new(config: CasterConfig) -> Self

Create a new Caster with the given configuration.

Source

pub fn caster_id(&self) -> &str

Returns the caster ID.

Source

pub fn config(&self) -> &CasterConfig

Returns a reference to the configuration.

Source

pub fn rune_count(&self) -> usize

Returns the number of registered runes.

Source

pub fn get_rune_config(&self, name: &str) -> Option<RuneConfig>

Returns the config of a registered rune by name.

Source

pub fn is_stream_rune(&self, name: &str) -> bool

Check if a rune is registered as a stream handler.

Source

pub fn stop(&self)

Signal the Caster to stop its run loop.

Safe to call from any thread or task. The run() method will return shortly after this is called. Idempotent — calling multiple times is safe.

Source

pub fn rune_accepts_files(&self, name: &str) -> bool

Check if a rune handler accepts file attachments.

Source

pub fn rune<F, Fut>(&self, config: RuneConfig, handler: F) -> SdkResult<()>
where F: Fn(RuneContext, Bytes) -> Fut + Send + Sync + 'static, Fut: Future<Output = SdkResult<Bytes>> + Send + 'static,

Register a unary rune handler.

The handler receives (RuneContext, Bytes) and returns Result<Bytes>.

§Errors

Returns SdkError::DuplicateRune if a rune with the same name already exists.

Source

pub fn rune_with_files<F, Fut>( &self, config: RuneConfig, handler: F, ) -> SdkResult<()>
where F: Fn(RuneContext, Bytes, Vec<FileAttachment>) -> Fut + Send + Sync + 'static, Fut: Future<Output = SdkResult<Bytes>> + Send + 'static,

Register a unary rune handler that accepts file attachments.

Source

pub fn stream_rune<F, Fut>( &self, config: RuneConfig, handler: F, ) -> SdkResult<()>
where F: Fn(RuneContext, Bytes, StreamSender) -> Fut + Send + Sync + 'static, Fut: Future<Output = SdkResult<()>> + Send + 'static,

Register a streaming rune handler.

The handler receives (RuneContext, Bytes, StreamSender) and returns Result<()>.

Source

pub fn stream_rune_with_files<F, Fut>( &self, config: RuneConfig, handler: F, ) -> SdkResult<()>
where F: Fn(RuneContext, Bytes, Vec<FileAttachment>, StreamSender) -> Fut + Send + Sync + 'static, Fut: Future<Output = SdkResult<()>> + Send + 'static,

Register a streaming rune handler that accepts file attachments.

Source

pub async fn run(&self) -> SdkResult<()>

Start the Caster (blocking async). Connects to Runtime with auto-reconnect.

Returns when the session ends normally, or when stop() is called, or on unrecoverable error.

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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
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