Struct web_sys::Selection

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

The Selection class.

MDN Documentation

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

Implementations

impl Selection

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

impl Selection

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

impl Selection

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

impl Selection

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

impl Selection

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

impl Selection

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

impl Selection

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

impl Selection

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

impl Selection

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

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

Methods from Deref<Target = Object>

pub fn constructor(&self) -> Function

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

MDN documentation

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

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

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

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

MDN documentation

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

pub fn to_string(&self) -> JsString

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

MDN documentation

pub fn value_of(&self) -> Object

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

MDN documentation

Methods from Deref<Target = JsValue>

pub const NULL: JsValue

pub const UNDEFINED: JsValue

pub const TRUE: JsValue

pub const FALSE: JsValue

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.

pub fn is_string(&self) -> bool

Tests whether this JS value is a JS string.

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.

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.

pub fn is_null(&self) -> bool

Tests whether this JS value is null

pub fn is_undefined(&self) -> bool

Tests whether this JS value is undefined

pub fn is_symbol(&self) -> bool

Tests whether the type of this JS value is symbol

pub fn is_object(&self) -> bool

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

pub fn is_function(&self) -> bool

Tests whether the type of this JS value is function.

pub fn is_truthy(&self) -> bool

Tests whether the value is “truthy”.

pub fn is_falsy(&self) -> bool

Tests whether the value is “falsy”.

Trait Implementations

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 AsRef<Selection> for Selection

fn as_ref(&self) -> &Selection

Performs the conversion.

impl Clone for Selection

fn clone(&self) -> Selection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Selection

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

Formats the value using the given formatter.

impl Deref for Selection

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Object

Dereferences the value.

impl Eq for Selection

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 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) -> Self

Recover a Self 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) -> 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) -> Self::Abi

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

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.

pub fn has_type<T>(&self) -> bool where
    T: JsCast, 

Test whether this JS value has a type T.

pub 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.

pub 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.

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

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

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

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

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

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

pub fn is_type_of(val: &JsValue) -> bool

Performs a dynamic check to see whether the JsValue provided is a value of this type.

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.

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 PartialEq<Selection> for Selection

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

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) -> Self::Anchor

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

impl StructuralEq for Selection

impl StructuralPartialEq for Selection

impl WasmDescribe for Selection

fn describe()