Struct script::dom::intersectionobserver::IntersectionObserver

#[repr(C)]
pub struct IntersectionObserver {
    reflector_: Reflector,
    callback: Rc<IntersectionObserverCallback>,
}

The Intersection Observer interface

The IntersectionObserver interface can be used to observe changes in the intersection of an intersection root and one or more target Elements.

https://w3c.github.io/IntersectionObserver/#intersection-observer-interface

Fields

reflector_: Reflector

callback: Rc<IntersectionObserverCallback>

This callback will be invoked when there are changes to a target’s intersection with the intersection root, as per the processing model. https://w3c.github.io/IntersectionObserver/#intersection-observer-callback

Implementations

impl IntersectionObserver

fn __assert_parent_type(&self)

impl IntersectionObserver

pub fn new_inherited( callback: Rc<IntersectionObserverCallback>, _init: &IntersectionObserverInit, ) -> Self

fn new( window: &Window, proto: Option<HandleObject<'_>>, callback: Rc<IntersectionObserverCallback>, init: &IntersectionObserverInit, can_gc: CanGc, ) -> Root<Dom<Self>>

Trait Implementations

impl DomObject for IntersectionObserver

fn reflector(&self) -> &Reflector

Returns the receiver’s reflector.

fn global(&self) -> Root<Dom<GlobalScope>>

where Self: Sized,

Returns the global scope of the realm that the DomObject was created in.

impl DomObjectWrap for IntersectionObserver

const WRAP: unsafe fn(_: SafeJSContext, _: &GlobalScope, _: Option<HandleObject<'_>>, _: Box<Self>, _: CanGc) -> Root<Dom<Self>> = {dom::bindings::codegen::Bindings::IntersectionObserverBinding::IntersectionObserver_Binding::Wrap as for<'a, 'b> unsafe fn(script_runtime::JSContext, &'a dom::globalscope::GlobalScope, std::option::Option<js::rust::Handle<'b, *mut js::jsapi::JSObject>>, std::boxed::Box<dom::intersectionobserver::IntersectionObserver>, script_runtime::CanGc) -> dom::bindings::root::Root<dom::bindings::root::Dom<dom::intersectionobserver::IntersectionObserver>>}

Function pointer to the general wrap function type

impl HasParent for IntersectionObserver

fn as_parent(&self) -> &Reflector

This is used in a type assertion to ensure that the source and webidls agree as to what the parent type is

type Parent = Reflector

impl IDLInterface for IntersectionObserver

fn derives(class: &'static DOMClass) -> bool

Returns whether the given DOM class derives that interface.

impl IntersectionObserverMethods<DomTypeHolder> for IntersectionObserver

fn GetRoot(&self) -> Option<ElementOrDocument>

The root provided to the IntersectionObserver constructor, or null if none was provided.

https://w3c.github.io/IntersectionObserver/#dom-intersectionobserver-root

fn RootMargin(&self) -> DOMString

Offsets applied to the root intersection rectangle, effectively growing or shrinking the box that is used to calculate intersections. These offsets are only applied when handling same-origin-domain targets; for cross-origin-domain targets they are ignored.

https://w3c.github.io/IntersectionObserver/#dom-intersectionobserver-rootmargin

fn ScrollMargin(&self) -> DOMString

Offsets are applied to scrollports on the path from intersection root to target, effectively growing or shrinking the clip rects used to calculate intersections.

https://w3c.github.io/IntersectionObserver/#dom-intersectionobserver-scrollmargin

fn Thresholds(&self, _context: JSContext, _retval: MutableHandleValue<'_>)

A list of thresholds, sorted in increasing numeric order, where each threshold is a ratio of intersection area to bounding box area of an observed target. Notifications for a target are generated when any of the thresholds are crossed for that target. If no options.threshold was provided to the IntersectionObserver constructor, or the sequence is empty, the value of this attribute will be [0].

https://w3c.github.io/IntersectionObserver/#dom-intersectionobserver-thresholds

fn Delay(&self) -> i32

A number indicating the minimum delay in milliseconds between notifications from this observer for a given target.

https://w3c.github.io/IntersectionObserver/#dom-intersectionobserver-delay

fn TrackVisibility(&self) -> bool

A boolean indicating whether this IntersectionObserver will track changes in a target’s visibility.

https://w3c.github.io/IntersectionObserver/#dom-intersectionobserver-trackvisibility

fn Observe(&self, _target: &Element)

Run the observe a target Element algorithm, providing this and target.

https://w3c.github.io/IntersectionObserver/#dom-intersectionobserver-observe

fn Unobserve(&self, _target: &Element)

Run the unobserve a target Element algorithm, providing this and target.

https://w3c.github.io/IntersectionObserver/#dom-intersectionobserver-unobserve

fn Disconnect(&self)

https://w3c.github.io/IntersectionObserver/#dom-intersectionobserver-disconnect

fn TakeRecords(&self) -> Vec<Root<Dom<IntersectionObserverEntry>>>

https://w3c.github.io/IntersectionObserver/#dom-intersectionobserver-takerecords

fn Constructor( window: &Window, proto: Option<HandleObject<'_>>, can_gc: CanGc, callback: Rc<IntersectionObserverCallback>, init: &IntersectionObserverInit, ) -> Root<Dom<IntersectionObserver>>

https://w3c.github.io/IntersectionObserver/#dom-intersectionobserver-intersectionobserver

impl MallocSizeOf for IntersectionObserver

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself.

impl MutDomObject for IntersectionObserver

unsafe fn init_reflector(&self, obj: *mut JSObject)

Initializes the Reflector

impl PartialEq for IntersectionObserver

fn eq(&self, other: &Self) -> 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 ToJSValConvertible for IntersectionObserver

unsafe fn to_jsval(&self, cx: *mut JSContext, rval: MutableHandleValue<'_>)

Convert self to a JSVal. JSAPI failure causes a panic.

impl Traceable for IntersectionObserver

unsafe fn trace(&self, tracer: *mut JSTracer)

Trace self.

impl Eq for IntersectionObserver