Skip to main content

MindMapHandle

Struct MindMapHandle 

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

Copyable shared document handle. Mutation always passes through checked core transactions. Individual views own their viewport, editor and mounted nodes.

Implementations§

Source§

impl MindMapHandle

Source

pub fn document(self) -> Result<MindMapData, MindMapError>

Read a reactive persistent snapshot. No internal mutable signal is exposed.

Source

pub fn selection(self) -> Result<Vec<String>, MindMapError>

Current selected IDs, reactively tracked.

Source

pub fn revision(self) -> Result<u64, MindMapError>

Current generation, reactively tracked.

Source

pub fn is_read_only(self) -> Result<bool, MindMapError>

Whether mutation is disabled.

Source

pub fn set_before( self, hook: impl Fn(&Operation) -> bool + 'static, ) -> Result<(), MindMapError>

Set a synchronous veto hook. Invoked without a state borrow; reentrant mutations cause the outer operation to fail with StaleOperation.

Source

pub fn clear_before(self) -> Result<(), MindMapError>

Clear the veto hook.

Source

pub fn set_listener( self, listener: impl Fn(CoreEvent) + 'static, ) -> Result<(), MindMapError>

Install a host event listener. Events are delivered after releasing state.

Source

pub fn apply( self, operation: Operation, ) -> Result<OperationResult, MindMapError>

Execute a checked mutation using the current before hook.

Source

pub fn apply_with( self, operation: Operation, options: OperationOptions, ) -> Result<OperationResult, MindMapError>

Execute a checked mutation with explicit recording options.

Source

pub fn select(self, ids: &[String]) -> Result<(), MindMapError>

Select existing IDs, including collapsed descendants.

Source

pub fn set_read_only(self, value: bool) -> Result<(), MindMapError>

Enable/disable all document mutation entry points.

Source

pub fn undo(self) -> Result<(), MindMapError>

Undo and restore selection.

Source

pub fn redo(self) -> Result<(), MindMapError>

Redo and restore selection.

Source

pub fn refresh(self, data: MindMapData) -> Result<(), MindMapError>

Validate and replace the document, clearing selection and history.

Source

pub fn subscribe( self, listener: impl Fn(CoreEvent) + 'static, ) -> Result<Subscription, MindMapError>

Add an independent listener. Dropping the returned guard unsubscribes it.

Source

pub fn register_plugin( self, plugin: Plugin, ) -> Result<PluginGuard, MindMapError>

Register a plugin for the lifetime of a guard. No document/history mutation.

Source

pub fn set_plugin_enabled( self, id: &str, enabled: bool, ) -> Result<(), MindMapError>

Toggle an existing registration. Disabled capabilities disappear reactively.

Source

pub fn has_plugin(self, capability: Capability) -> bool

Test an enabled capability for this document only.

Source

pub fn plugin_commands(self) -> Result<Vec<Command>, MindMapError>

Commands supplied by enabled plugins.

Trait Implementations§

Source§

impl Clone for MindMapHandle

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

Source§

impl PartialEq for MindMapHandle

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for MindMapHandle

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> DependencyElement for T
where T: 'static + PartialEq + Clone,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> InitializeFromFunction<T> for T

Source§

fn initialize_from_function(f: fn() -> T) -> T

Create an instance of this type from an initialization function
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<Ret> SpawnIfAsync<(), Ret> for Ret

Source§

fn spawn(self) -> Ret

Spawn the value into the dioxus runtime if it is an async block
Source§

impl<T, O> SuperFrom<T> for O
where O: From<T>,

Source§

fn super_from(input: T) -> O

Convert from a type to another type.
Source§

impl<T, O, M> SuperInto<O, M> for T
where O: SuperFrom<T, M>,

Source§

fn super_into(self) -> O

Convert from a type to another type.
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<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
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