Struct web_sys::Selection

#[repr(transparent)]
pub struct Selection { /* fields omitted */ }

The Selection object

MDN Documentation

This API requires the following crate features to be activated: Selection

Methods

impl Selection

pub fn add_range(&self, range: &Range) -> Result<(), JsValue>

The addRange() method

MDN Documentation

This API requires the following crate features to be activated: Range, Selection

impl Selection

pub fn collapse(&self, node: Option<&Node>) -> Result<(), JsValue>

The collapse() method

MDN Documentation

This API requires the following crate features to be activated: Node, Selection

impl Selection

pub fn collapse_with_offset(
    &self,
    node: Option<&Node>,
    offset: u32
) -> Result<(), JsValue>

The collapse() method

MDN Documentation

This API requires the following crate features to be activated: Node, Selection

impl Selection

pub fn collapse_to_end(&self) -> Result<(), JsValue>

The collapseToEnd() method

MDN Documentation

This API requires the following crate features to be activated: Selection

impl Selection

pub fn collapse_to_start(&self) -> Result<(), JsValue>

The collapseToStart() method

MDN Documentation

This API requires the following crate features to be activated: Selection

impl Selection

pub fn contains_node(&self, node: &Node) -> Result<bool, JsValue>

The containsNode() method

MDN Documentation

This API requires the following crate features to be activated: Node, Selection

impl Selection

pub fn contains_node_with_allow_partial_containment(
    &self,
    node: &Node,
    allow_partial_containment: bool
) -> Result<bool, JsValue>

The containsNode() method

MDN Documentation

This API requires the following crate features to be activated: Node, Selection

impl Selection

pub fn delete_from_document(&self) -> Result<(), JsValue>

The deleteFromDocument() method

MDN Documentation

This API requires the following crate features to be activated: Selection

impl Selection

pub fn empty(&self) -> Result<(), JsValue>

The empty() method

MDN Documentation

This API requires the following crate features to be activated: Selection

impl Selection

pub fn extend(&self, node: &Node) -> Result<(), JsValue>

The extend() method

MDN Documentation

This API requires the following crate features to be activated: Node, Selection

impl Selection

pub fn extend_with_offset(
    &self,
    node: &Node,
    offset: u32
) -> Result<(), JsValue>

The extend() method

MDN Documentation

This API requires the following crate features to be activated: Node, Selection

impl Selection

pub fn get_range_at(&self, index: u32) -> Result<Range, JsValue>

The getRangeAt() method

MDN Documentation

This API requires the following crate features to be activated: Range, Selection

impl Selection

pub fn modify(
    &self,
    alter: &str,
    direction: &str,
    granularity: &str
) -> Result<(), JsValue>

The modify() method

MDN Documentation

This API requires the following crate features to be activated: Selection

impl Selection

pub fn remove_all_ranges(&self) -> Result<(), JsValue>

The removeAllRanges() method

MDN Documentation

This API requires the following crate features to be activated: Selection

impl Selection

pub fn remove_range(&self, range: &Range) -> Result<(), JsValue>

The removeRange() method

MDN Documentation

This API requires the following crate features to be activated: Range, Selection

impl Selection

pub fn select_all_children(&self, node: &Node) -> Result<(), JsValue>

The selectAllChildren() method

MDN Documentation

This API requires the following crate features to be activated: Node, Selection

impl Selection

pub fn set_base_and_extent(
    &self,
    anchor_node: &Node,
    anchor_offset: u32,
    focus_node: &Node,
    focus_offset: u32
) -> Result<(), JsValue>

The setBaseAndExtent() method

MDN Documentation

This API requires the following crate features to be activated: Node, Selection

impl Selection

pub fn set_position(&self, node: Option<&Node>) -> Result<(), JsValue>

The setPosition() method

MDN Documentation

This API requires the following crate features to be activated: Node, Selection

impl Selection

pub fn set_position_with_offset(
    &self,
    node: Option<&Node>,
    offset: u32
) -> Result<(), JsValue>

The setPosition() method

MDN Documentation

This API requires the following crate features to be activated: Node, Selection

impl Selection

pub fn anchor_node(&self) -> Option<Node>

The anchorNode getter

MDN Documentation

This API requires the following crate features to be activated: Node, Selection

impl Selection

pub fn anchor_offset(&self) -> u32

The anchorOffset getter

MDN Documentation

This API requires the following crate features to be activated: Selection

impl Selection

pub fn focus_node(&self) -> Option<Node>

The focusNode getter

MDN Documentation

This API requires the following crate features to be activated: Node, Selection

impl Selection

pub fn focus_offset(&self) -> u32

The focusOffset getter

MDN Documentation

This API requires the following crate features to be activated: Selection

impl Selection

pub fn is_collapsed(&self) -> bool

The isCollapsed getter

MDN Documentation

This API requires the following crate features to be activated: Selection

impl Selection

pub fn range_count(&self) -> u32

The rangeCount getter

MDN Documentation

This API requires the following crate features to be activated: Selection

impl Selection

pub fn type_(&self) -> String

The type getter

MDN Documentation

This API requires the following crate features to be activated: Selection

impl Selection

pub fn caret_bidi_level(&self) -> Result<Option<i16>, JsValue>

The caretBidiLevel getter

MDN Documentation

This API requires the following crate features to be activated: Selection

impl Selection

pub fn set_caret_bidi_level(
    &self,
    caret_bidi_level: Option<i16>
) -> Result<(), JsValue>

The caretBidiLevel setter

MDN Documentation

This API requires the following crate features to be activated: Selection

Trait Implementations

impl Clone for Selection

fn clone(&self) -> Selection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl AsRef<JsValue> for Selection

fn as_ref(&self) -> &JsValue

Performs the conversion.

impl AsRef<Object> for Selection

fn as_ref(&self) -> &Object

Performs the conversion.

impl From<JsValue> for Selection

fn from(obj: JsValue) -> Selection

Performs the conversion.

impl From<Selection> for JsValue

fn from(obj: Selection) -> JsValue

Performs the conversion.

impl From<Selection> for Object

fn from(obj: Selection) -> Object

Performs the conversion.

impl Deref for Selection

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Object

Dereferences the value.

impl Debug for Selection

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

Formats the value using the given formatter.

impl JsCast for Selection

fn instanceof(val: &JsValue) -> bool

Performs a dynamic instanceof check to see whether the JsValue provided is an instance of this type.

fn unchecked_from_js(val: JsValue) -> Self

Performs a zero-cost unchecked conversion from a JsValue into an instance of Self

fn unchecked_from_js_ref(val: &JsValue) -> &Self

Performs a zero-cost unchecked conversion from a &JsValue into an instance of &Self.

default fn is_instance_of<T>(&self) -> bool where
    T: JsCast, 

Test whether this JS value is an instance of the type T.

default fn dyn_into<T>(self) -> Result<T, Self> where
    T: JsCast, 

Performs a dynamic cast (checked at runtime) of this value into the target type T.

default fn dyn_ref<T>(&self) -> Option<&T> where
    T: JsCast, 

Performs a dynamic cast (checked at runtime) of this value into the target type T.

default fn unchecked_into<T>(self) -> T where
    T: JsCast, 

Performs a zero-cost unchecked cast into the specified type.

default fn unchecked_ref<T>(&self) -> &T where
    T: JsCast, 

Performs a zero-cost unchecked cast into a reference to the specified type.

impl RefFromWasmAbi for Selection

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<Selection>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don't persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi, extra: &mut dyn Stack) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl IntoWasmAbi for Selection

type Abi = <JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self, extra: &mut dyn Stack) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl<'a> IntoWasmAbi for &'a Selection

type Abi = <&'a JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self, extra: &mut dyn Stack) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl WasmDescribe for Selection

fn describe()

impl FromWasmAbi for Selection

type Abi = <JsValue as FromWasmAbi>::Abi

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi, extra: &mut dyn Stack) -> Self

Recover a Self from Self::Abi.

impl OptionIntoWasmAbi for Selection

fn none() -> Self::Abi

Returns an ABI instance indicating "none", which JS will interpret as the None branch of this option.

impl<'a> OptionIntoWasmAbi for &'a Selection

fn none() -> Self::Abi

Returns an ABI instance indicating "none", which JS will interpret as the None branch of this option.

impl OptionFromWasmAbi for Selection

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a "none" instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.