Skip to main content

UseCacheUpdate

Struct UseCacheUpdate 

Source
pub struct UseCacheUpdate {
    pub doc_status: Signal<bool>,
    pub version: Signal<String>,
    pub updating: Signal<bool>,
}
Expand description

Reactive state for the cache update feature.

Tracks the documentation build status, the latest version string, and whether a cache update is currently in progress.

Fields§

§doc_status: Signal<bool>

Whether the docs.rs build status indicates documentation is available.

§version: Signal<String>

The latest version string returned by docs.rs.

§updating: Signal<bool>

Whether a cache update operation is currently in progress.

Implementations§

Source§

impl UseCacheUpdate

Implementation of cache update functionality.

Source

pub fn use_cache_state() -> UseCacheUpdate

Creates cache update state for tracking documentation build status.

Initializes doc_status to false, version to an empty string, and updating to false. The actual data is loaded asynchronously via Self::load.

§Returns
  • UseCacheUpdate: The cache update state.
Source

pub fn load(self, current_version: &str, config: Option<BridgeConfig>)

Asynchronously fetches the docs.rs status JSON and invokes the bridge update_cache command to synchronize the local cache.

First fetches DOCS_STATUS_URL and parses the { "doc_status": bool, "version": string } JSON payload into the provided state signals. If the remote version is greater than EUV_VERSION and the bridge is available, invokes the update_cache command via window.bridge.core.invoke("update_cache") and updates the updating signal accordingly.

§Arguments
  • &str: The current version string for comparison.
  • Option<BridgeConfig>: Optional custom bridge configuration.
Source§

impl UseCacheUpdate

Source

pub fn get_doc_status(&self) -> Signal<bool>

Source

pub fn get_mut_doc_status(&mut self) -> &mut Signal<bool>

Source

pub fn set_doc_status(&mut self, val: Signal<bool>) -> &mut Self

Source

pub fn get_version(&self) -> Signal<String>

Source

pub fn get_mut_version(&mut self) -> &mut Signal<String>

Source

pub fn set_version(&mut self, val: Signal<String>) -> &mut Self

Source

pub fn get_updating(&self) -> Signal<bool>

Source

pub fn get_mut_updating(&mut self) -> &mut Signal<bool>

Source

pub fn set_updating(&mut self, val: Signal<bool>) -> &mut Self

Source§

impl UseCacheUpdate

Source

pub fn new( doc_status: Signal<bool>, version: Signal<String>, updating: Signal<bool>, ) -> Self

Trait Implementations§

Source§

impl Clone for UseCacheUpdate

Source§

fn clone(&self) -> UseCacheUpdate

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 Copy for UseCacheUpdate

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> 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 = 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<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more