Struct stdweb::web::MutationObserverHandle

pub struct MutationObserverHandle { /* fields omitted */ }

A wrapper which ensures that memory is properly cleaned up when it's no longer needed.

This is created by the MutationObserver::new method, and it can use the same methods as MutationObserver.

When the MutationObserverHandle is dropped, the disconnect method will automatically be called.

Methods from Deref<Target = MutationObserver>

pub fn observe<T: INode>(
    &self,
    target: &T,
    options: MutationObserverInit
) -> Result<(), TODO>

Starts observing changes to the target.

When the target is changed, the MutationObserver is notified with a vector of MutationRecord.

The options specifies which changes should be observed.

Multiple different targets can be observed simultaneously (with the same or different options).

If you call observe on the same target multiple times, it will replace the old options with the new options. It will not notify multiple times for the same change to the same target.

Panics

• At least one of child_list, attributes, or character_data must be true.

• If attribute_old_value is true, then attributes must be true.

• If character_data_old_value is true, then character_data must be true.

• If attribute_filter is Some, then attributes must be true.

(JavaScript docs)

pub fn disconnect(&self)

Stops observing all targets.

Until the observe method is called again, the MutationObserver will not be notified of any changes.

(JavaScript docs)

pub fn take_records(&self) -> Vec<MutationRecord>

Empties the MutationObserver's record queue and returns what was in there.

This method is generally not needed, instead use the MutationObserver callback to respond to changes.

(JavaScript docs)

Trait Implementations

impl Drop for MutationObserverHandle

fn drop(&mut self)

Executes the destructor for this type.

impl Debug for MutationObserverHandle

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

Formats the value using the given formatter.

impl Deref for MutationObserverHandle

type Target = MutationObserver

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.