Skip to main content

Connection

Struct Connection 

Source
pub struct Connection(/* private fields */);
Expand description

The connection to zero-cache (Connection in packages/zero-client/src/client/connection.ts).

Implementations§

Source§

impl Connection

Source

pub fn state(&self) -> ConnectionState

The state now.

Source

pub fn update_needed(&self) -> Option<UpdateNeededReason>

Why the app must be updated to sync, once the server said so (onUpdateNeeded). Reconnecting doesn’t help.

Source

pub fn subscribe( &self, listener: impl Fn(&ConnectionState) + 'static, ) -> Box<dyn Fn()>

Calls listener on every change of state. Returns the function that removes it.

Source

pub fn connect(&self, auth: ConnectAuth) -> Result<(), Error>

Resumes connecting from needs-auth or error (connect in connection.ts). From any other state it only applies auth, and after a disconnect for a missing cache_url it never reconnects.

auth first sets or clears the token, as connect({auth}) does; when already connected, the server gets a new non-empty token in updateAuth. A token on a client without a user_id is an Error::Connection of kind Internal (JS’s rejection), and nothing changes.

It returns once the connection is asked to resume, not once it has: JS’s promise waits for the next state, which subscribe follows here.

Trait Implementations§

Source§

impl Clone for Connection

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

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