Selection

Struct Selection 

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

The Selection class.

MDN Documentation

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

Implementations§

Source§

impl Selection

Source

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

Getter for the anchorNode field of this object.

MDN Documentation

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

Source§

impl Selection

Source

pub fn anchor_offset(&self) -> u32

Getter for the anchorOffset field of this object.

MDN Documentation

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

Source§

impl Selection

Source

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

Getter for the focusNode field of this object.

MDN Documentation

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

Source§

impl Selection

Source

pub fn focus_offset(&self) -> u32

Getter for the focusOffset field of this object.

MDN Documentation

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

Source§

impl Selection

Source

pub fn is_collapsed(&self) -> bool

Getter for the isCollapsed field of this object.

MDN Documentation

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

Source§

impl Selection

Source

pub fn range_count(&self) -> u32

Getter for the rangeCount field of this object.

MDN Documentation

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

Source§

impl Selection

Source

pub fn type_(&self) -> String

Getter for the type field of this object.

MDN Documentation

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

Source§

impl Selection

Source

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

Getter for the caretBidiLevel field of this object.

MDN Documentation

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

Source§

impl Selection

Source

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

Setter for the caretBidiLevel field of this object.

MDN Documentation

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

Source§

impl Selection

Source

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

Source§

impl Selection

Source

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

Source§

impl Selection

Source

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

Source§

impl Selection

Source

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

The collapseToEnd() method.

MDN Documentation

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

Source§

impl Selection

Source

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

The collapseToStart() method.

MDN Documentation

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

Source§

impl Selection

Source

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

Source§

impl Selection

Source

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

Source§

impl Selection

Source

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

The deleteFromDocument() method.

MDN Documentation

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

Source§

impl Selection

Source

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

The empty() method.

MDN Documentation

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

Source§

impl Selection

Source

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

Source§

impl Selection

Source

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

Source§

impl Selection

Source

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

Source§

impl Selection

Source

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

Source§

impl Selection

Source

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

The removeAllRanges() method.

MDN Documentation

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

Source§

impl Selection

Source

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

Source§

impl Selection

Source

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

Source§

impl Selection

Source

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

Source§

impl Selection

Source

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

Source§

impl Selection

Source

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

Methods from Deref<Target = Object>§

Source

pub fn constructor(&self) -> Function

The constructor property returns a reference to the Object constructor function that created the instance object.

MDN documentation

Source

pub fn has_own_property(&self, property: &JsValue) -> bool

The hasOwnProperty() method returns a boolean indicating whether the object has the specified property as its own property (as opposed to inheriting it).

MDN documentation

Source

pub fn is_prototype_of(&self, value: &JsValue) -> bool

The isPrototypeOf() method checks if an object exists in another object’s prototype chain.

MDN documentation

Source

pub fn property_is_enumerable(&self, property: &JsValue) -> bool

The propertyIsEnumerable() method returns a Boolean indicating whether the specified property is enumerable.

MDN documentation

Source

pub fn to_locale_string(&self) -> JsString

The toLocaleString() method returns a string representing the object. This method is meant to be overridden by derived objects for locale-specific purposes.

MDN documentation

Source

pub fn to_string(&self) -> JsString

The toString() method returns a string representing the object.

MDN documentation

Source

pub fn value_of(&self) -> Object

The valueOf() method returns the primitive value of the specified object.

MDN documentation

Methods from Deref<Target = JsValue>§

Source

pub const NULL: JsValue

Source

pub const UNDEFINED: JsValue

Source

pub const TRUE: JsValue

Source

pub const FALSE: JsValue

Source

pub fn as_f64(&self) -> Option<f64>

Returns the f64 value of this JS value if it’s an instance of a number.

If this JS value is not an instance of a number then this returns None.

Source

pub fn is_string(&self) -> bool

Tests whether this JS value is a JS string.

Source

pub fn as_string(&self) -> Option<String>

If this JS value is a string value, this function copies the JS string value into Wasm linear memory, encoded as UTF-8, and returns it as a Rust String.

To avoid the copying and re-encoding, consider the JsString::try_from() function from js-sys instead.

If this JS value is not an instance of a string or if it’s not valid utf-8 then this returns None.

§UTF-16 vs UTF-8

JavaScript strings in general are encoded as UTF-16, but Rust strings are encoded as UTF-8. This can cause the Rust string to look a bit different than the JS string sometimes. For more details see the documentation about the str type which contains a few caveats about the encodings.

Source

pub fn as_bool(&self) -> Option<bool>

Returns the bool value of this JS value if it’s an instance of a boolean.

If this JS value is not an instance of a boolean then this returns None.

Source

pub fn is_null(&self) -> bool

Tests whether this JS value is null

Source

pub fn is_undefined(&self) -> bool

Tests whether this JS value is undefined

Source

pub fn is_symbol(&self) -> bool

Tests whether the type of this JS value is symbol

Source

pub fn is_object(&self) -> bool

Tests whether typeof self == "object" && self !== null.

Source

pub fn is_array(&self) -> bool

Tests whether this JS value is an instance of Array.

Source

pub fn is_function(&self) -> bool

Tests whether the type of this JS value is function.

Source

pub fn is_bigint(&self) -> bool

Tests whether the type of this JS value is bigint.

Source

pub fn js_typeof(&self) -> JsValue

Applies the unary typeof JS operator on a JsValue.

MDN documentation

Source

pub fn js_in(&self, obj: &JsValue) -> bool

Applies the binary in JS operator on the two JsValues.

MDN documentation

Source

pub fn is_truthy(&self) -> bool

Tests whether the value is “truthy”.

Source

pub fn is_falsy(&self) -> bool

Tests whether the value is “falsy”.

Source

pub fn loose_eq(&self, other: &JsValue) -> bool

Compare two JsValues for equality, using the == operator in JS.

MDN documentation

Source

pub fn bit_not(&self) -> JsValue

Applies the unary ~ JS operator on a JsValue.

MDN documentation

Source

pub fn unsigned_shr(&self, rhs: &JsValue) -> u32

Applies the binary >>> JS operator on the two JsValues.

MDN documentation

Source

pub fn checked_div(&self, rhs: &JsValue) -> JsValue

Applies the binary / JS operator on two JsValues, catching and returning any RangeError thrown.

MDN documentation

Source

pub fn pow(&self, rhs: &JsValue) -> JsValue

Applies the binary ** JS operator on the two JsValues.

MDN documentation

Source

pub fn lt(&self, other: &JsValue) ->