Struct MutationObserver

pub struct MutationObserver(/* private fields */);

Provides a way to receive notifications about changes to the DOM.

(JavaScript docs)

Implementations

impl MutationObserver

pub fn new<F>(callback: F) -> MutationObserverHandle

where F: FnMut(Vec<MutationRecord>, Self) + 'static,

Returns a new MutationObserverHandle with the given callback.

The callback will be called with the following arguments when the observed DOM nodes change:

1. A vector of changes to the observed DOM nodes.

2. The MutationObserver.

(JavaScript docs)

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 AsRef<Reference> for MutationObserver

fn as_ref(&self) -> &Reference

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for MutationObserver

fn clone(&self) -> MutationObserver

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MutationObserver

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

Formats the value using the given formatter.

impl From<MutationObserver> for Reference

fn from(value: MutationObserver) -> Self

Converts to this type from the input type.

impl InstanceOf for MutationObserver

fn instance_of(reference: &Reference) -> bool

Checks whenever a given Reference if of type Self.

impl PartialEq for MutationObserver

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ReferenceType for MutationObserver

unsafe fn from_reference_unchecked(reference: Reference) -> Self

Converts a given reference into a concrete reference-like wrapper. Doesn’t do any type checking; highly unsafe to use!

impl<'_r> TryFrom<&'_r Reference> for MutationObserver

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(reference: &Reference) -> Result<Self, Self::Error>

Performs the conversion.

impl<'_r> TryFrom<&'_r Value> for MutationObserver

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<MutationObserver> for Reference

type Error = Void

The type returned in the event of a conversion error.

fn try_from(value: MutationObserver) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Reference> for MutationObserver

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(reference: Reference) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for MutationObserver

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for MutationObserver

impl JsSerialize for MutationObserver

impl StructuralPartialEq for MutationObserver