Skip to main content

SocketIo

Struct SocketIo 

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

Named socket.io clients shared by Rust and the webviews. Get it with SocketIoExt::socketio; cheap to clone.

Ids are unique: connect and insert fail with Error::AlreadyExists for an id in use, so a client is never replaced behind the back of whoever holds it. remove it first. reserve an id in setup when Rust registers it later: webviews then cannot take it.

Implementations§

Source§

impl SocketIo

Source

pub fn reserve(&self, id: impl Into<String>)

Keeps id for Rust: a webview’s connect with it fails with Error::Reserved, while connect and insert from Rust work. Call it in setup (it is synchronous) for every id Rust registers later, so no page script can take the id first. Reservations last for the life of the app.

Source

pub async fn connect( &self, id: impl Into<String>, builder: ClientBuilder, ) -> Result<Client>

Builds builder, connects and registers the client under id with Access::Full. Fails with the connect error, or Error::AlreadyExists (then the new client is dropped, which closes it).

Source

pub fn insert( &self, id: impl Into<String>, client: Client, access: Access, ) -> Result<()>

Registers a client built elsewhere, e.g. by Rust code that must stay free of Tauri. With Access::ReadOnly the webview can observe it but never emit, ack or disconnect it, whatever its capabilities allow. The registry keeps a clone; the client lives until it is removed and every other clone is dropped.

Source

pub fn get(&self, id: &str) -> Option<Client>

A clone of the client registered under id.

Source

pub fn access(&self, id: &str) -> Option<Access>

The access the webview has to id.

Source

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

The registered ids, sorted.

Source

pub fn remove(&self, id: &str) -> Option<Client>

Unregisters id: its subscriptions end (their channels are dropped) and its pending server acks are forgotten. Does not disconnect: the client is handed back (call Client::disconnect on it, or drop it; dropping the last clone closes it).

Source

pub fn subscribe( &self, id: &str, events: Option<Vec<String>>, channel: Channel<Message>, ) -> Result<SubscriptionId>

Forwards the client’s state transitions and events (all, or only events) to channel as Messages, starting with a snapshot of the current state. Ends with unsubscribe, remove or when a send fails. Server acks are not offered to subscriptions made from Rust (answer them in a handler).

Source

pub fn unsubscribe(&self, id: &str, subscription: SubscriptionId) -> bool

Stops a subscription; false when it was gone already.

Trait Implementations§

Source§

impl Clone for SocketIo

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for SocketIo

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SocketIo

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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: Sized + 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: Sized + 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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<T> UserEvent for T
where T: Debug + Clone + Send + 'static,

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