Skip to main content

PluginState

Struct PluginState 

Source
pub struct PluginState<R: Runtime> { /* private fields */ }
Expand description

Shared state for the conduit Tauri plugin.

Holds the router, named streaming channels, the per-launch invoke key, and the app handle for emitting push notifications.

Implementations§

Source§

impl<R: Runtime> PluginState<R>

Source

pub fn channel(&self, name: &str) -> Option<&Arc<ChannelBuffer>>

Get a channel by name (for pushing data from Rust handlers).

Source

pub fn push(&self, channel: &str, data: &[u8]) -> Result<(), String>

Push binary data to a named channel and notify JS listeners.

After writing to the channel, emits both a global conduit:data-available event (payload = channel name) and a per-channel conduit:data-available:{channel} event. JS subscribers can listen on either.

For lossy channels, oldest frames are silently dropped when the buffer is full. For reliable channels, returns an error if the buffer is full (backpressure).

Returns an error string if the named channel was not registered via the builder or if a reliable channel is full.

Source

pub fn channel_names(&self) -> Vec<String>

Return the list of registered channel names.

Trait Implementations§

Source§

impl<R: Runtime> Debug for PluginState<R>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<R> Freeze for PluginState<R>

§

impl<R> !RefUnwindSafe for PluginState<R>

§

impl<R> Send for PluginState<R>

§

impl<R> Sync for PluginState<R>

§

impl<R> Unpin for PluginState<R>

§

impl<R> UnsafeUnpin for PluginState<R>

§

impl<R> !UnwindSafe for PluginState<R>

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, 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, 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.