Enum leptos_use::core::ElementMaybeSignal

pub enum ElementMaybeSignal<T, E>
where
    T: Into<E> + Clone + 'static,
{
    Static(Option<T>),
    Dynamic(Signal<Option<T>>),
    _Phantom(PhantomData<E>),
}

Used as an argument type to make it easily possible to pass either

• a web_sys element that implements E (for example EventTarget, Element or HtmlElement),
• an Option<T> where T is the web_sys element,
• a Signal<T> where T is the web_sys element,
• a Signal<Option<T>> where T is the web_sys element,
• a NodeRef

into a function. Used for example in crate::use_event_listener.

Variants

Static(Option<T>)

Dynamic(Signal<Option<T>>)

_Phantom(PhantomData<E>)

Trait Implementations

impl<T, E> Clone for ElementMaybeSignal<T, E>

where T: Into<E> + Clone + 'static,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, E> Default for ElementMaybeSignal<T, E>

where T: Into<E> + Clone + 'static,

fn default() -> Self

Returns the “default value” for a type.

impl<'a, E> From<&'a str> for ElementMaybeSignal<Element, E>

where E: From<Element> + 'static,

fn from(target: &'a str) -> Self

Converts to this type from the input type.

impl<T, E> From<ElementMaybeSignal<T, E>> for ElementsMaybeSignal<T, E>

where T: Into<E> + Clone + 'static,

fn from(signal: ElementMaybeSignal<T, E>) -> Self

Converts to this type from the input type.

impl<HtmlEl> From<HtmlElement<HtmlEl>> for ElementMaybeSignal<Element, Element>

where HtmlEl: ElementDescriptor + Deref<Target = Element>,

fn from(value: HtmlElement<HtmlEl>) -> Self

Converts to this type from the input type.

impl<HtmlEl> From<HtmlElement<HtmlEl>> for ElementMaybeSignal<EventTarget, EventTarget>

where HtmlEl: ElementDescriptor + Deref<Target = EventTarget>,

fn from(value: HtmlElement<HtmlEl>) -> Self

Converts to this type from the input type.

impl<HtmlEl> From<HtmlElement<HtmlEl>> for ElementMaybeSignal<HtmlElement, HtmlElement>

where HtmlEl: ElementDescriptor + Deref<Target = HtmlElement>,

fn from(value: HtmlElement<HtmlEl>) -> Self

Converts to this type from the input type.

impl<E> From<Memo<&str>> for ElementMaybeSignal<Element, E>

where E: From<Element> + 'static,

fn from(signal: Memo<&str>) -> Self

Converts to this type from the input type.

impl<HtmlEl> From<Memo<HtmlElement<HtmlEl>>> for ElementMaybeSignal<Element, Element>

where HtmlEl: ElementDescriptor + Deref<Target = Element> + Clone,

fn from(value: Memo<HtmlElement<HtmlEl>>) -> Self

Converts to this type from the input type.

impl<HtmlEl> From<Memo<HtmlElement<HtmlEl>>> for ElementMaybeSignal<EventTarget, EventTarget>

where HtmlEl: ElementDescriptor + Deref<Target = EventTarget> + Clone,

fn from(value: Memo<HtmlElement<HtmlEl>>) -> Self

Converts to this type from the input type.

impl<HtmlEl> From<Memo<Option<HtmlElement<HtmlEl>>>> for ElementMaybeSignal<Element, Element>

where HtmlEl: ElementDescriptor + Deref<Target = Element> + Clone,

fn from(value: Memo<Option<HtmlElement<HtmlEl>>>) -> Self

Converts to this type from the input type.

impl<HtmlEl> From<Memo<Option<HtmlElement<HtmlEl>>>> for ElementMaybeSignal<EventTarget, EventTarget>

where HtmlEl: ElementDescriptor + Deref<Target = EventTarget> + Clone,

fn from(value: Memo<Option<HtmlElement<HtmlEl>>>) -> Self

Converts to this type from the input type.

impl<HtmlEl> From<Memo<Option<HtmlElement<HtmlEl>>>> for ElementMaybeSignal<HtmlElement, HtmlElement>

where HtmlEl: ElementDescriptor + Deref<Target = HtmlElement> + Clone,

fn from(value: Memo<Option<HtmlElement<HtmlEl>>>) -> Self

Converts to this type from the input type.

impl<T, E> From<Memo<Option<T>>> for ElementMaybeSignal<T, E>

where T: Into<E> + Clone + 'static,

fn from(target: Memo<Option<T>>) -> Self

Converts to this type from the input type.

impl<E> From<Memo<String>> for ElementMaybeSignal<Element, E>

where E: From<Element> + 'static,

fn from(signal: Memo<String>) -> Self

Converts to this type from the input type.

impl<T, E> From<Memo<T>> for ElementMaybeSignal<T, E>

where T: Into<E> + Clone + 'static,

fn from(signal: Memo<T>) -> Self

Converts to this type from the input type.

impl<R> From<NodeRef<R>> for ElementMaybeSignal<Element, Element>

where R: ElementDescriptor + Clone + 'static,

fn from(node_ref: NodeRef<R>) -> Self

Converts to this type from the input type.

impl<R> From<NodeRef<R>> for ElementMaybeSignal<EventTarget, EventTarget>

where R: ElementDescriptor + Clone + 'static,

fn from(node_ref: NodeRef<R>) -> Self

Converts to this type from the input type.

impl<R> From<NodeRef<R>> for ElementMaybeSignal<HtmlElement, HtmlElement>

where R: ElementDescriptor + Clone + 'static,

fn from(node_ref: NodeRef<R>) -> Self

Converts to this type from the input type.

impl<T, E> From<Option<T>> for ElementMaybeSignal<T, E>

where T: Into<E> + Clone + 'static,

fn from(target: Option<T>) -> Self

Converts to this type from the input type.

impl<E> From<ReadSignal<&str>> for ElementMaybeSignal<Element, E>

where E: From<Element> + 'static,

fn from(signal: ReadSignal<&str>) -> Self

Converts to this type from the input type.

impl<HtmlEl> From<ReadSignal<HtmlElement<HtmlEl>>> for ElementMaybeSignal<Element, Element>

where HtmlEl: ElementDescriptor + Deref<Target = Element> + Clone,

fn from(value: ReadSignal<HtmlElement<HtmlEl>>) -> Self

Converts to this type from the input type.

impl<HtmlEl> From<ReadSignal<HtmlElement<HtmlEl>>> for ElementMaybeSignal<EventTarget, EventTarget>

where HtmlEl: ElementDescriptor + Deref<Target = EventTarget> + Clone,

fn from(value: ReadSignal<HtmlElement<HtmlEl>>) -> Self

Converts to this type from the input type.

impl<HtmlEl> From<ReadSignal<Option<HtmlElement<HtmlEl>>>> for ElementMaybeSignal<Element, Element>

where HtmlEl: ElementDescriptor + Deref<Target = Element> + Clone,

fn from(value: ReadSignal<Option<HtmlElement<HtmlEl>>>) -> Self

Converts to this type from the input type.

impl<HtmlEl> From<ReadSignal<Option<HtmlElement<HtmlEl>>>> for ElementMaybeSignal<EventTarget, EventTarget>

where HtmlEl: ElementDescriptor + Deref<Target = EventTarget> + Clone,

fn from(value: ReadSignal<Option<HtmlElement<HtmlEl>>>) -> Self

Converts to this type from the input type.

impl<HtmlEl> From<ReadSignal<Option<HtmlElement<HtmlEl>>>> for ElementMaybeSignal<HtmlElement, HtmlElement>

where HtmlEl: ElementDescriptor + Deref<Target = HtmlElement> + Clone,

fn from(value: ReadSignal<Option<HtmlElement<HtmlEl>>>) -> Self

Converts to this type from the input type.

impl<T, E> From<ReadSignal<Option<T>>> for ElementMaybeSignal<T, E>

where T: Into<E> + Clone + 'static,

fn from(target: ReadSignal<Option<T>>) -> Self

Converts to this type from the input type.

impl<E> From<ReadSignal<String>> for ElementMaybeSignal<Element, E>

where E: From<Element> + 'static,

fn from(signal: ReadSignal<String>) -> Self

Converts to this type from the input type.

impl<T, E> From<ReadSignal<T>> for ElementMaybeSignal<T, E>

where T: Into<E> + Clone + 'static,

fn from(signal: ReadSignal<T>) -> Self

Converts to this type from the input type.

impl<E> From<RwSignal<&str>> for ElementMaybeSignal<Element, E>

where E: From<Element> + 'static,

fn from(signal: RwSignal<&str>) -> Self

Converts to this type from the input type.

impl<HtmlEl> From<RwSignal<HtmlElement<HtmlEl>>> for ElementMaybeSignal<Element, Element>

where HtmlEl: ElementDescriptor + Deref<Target = Element> + Clone,

fn from(value: RwSignal<HtmlElement<HtmlEl>>) -> Self

Converts to this type from the input type.

impl<HtmlEl> From<RwSignal<HtmlElement<HtmlEl>>> for ElementMaybeSignal<EventTarget, EventTarget>

where HtmlEl: ElementDescriptor + Deref<Target = EventTarget> + Clone,

fn from(value: RwSignal<HtmlElement<HtmlEl>>) -> Self

Converts to this type from the input type.

impl<HtmlEl> From<RwSignal<Option<HtmlElement<HtmlEl>>>> for ElementMaybeSignal<Element, Element>

where HtmlEl: ElementDescriptor + Deref<Target = Element> + Clone,

fn from(value: RwSignal<Option<HtmlElement<HtmlEl>>>) -> Self

Converts to this type from the input type.

impl<HtmlEl> From<RwSignal<Option<HtmlElement<HtmlEl>>>> for ElementMaybeSignal<EventTarget, EventTarget>

where HtmlEl: ElementDescriptor + Deref<Target = EventTarget> + Clone,

fn from(value: RwSignal<Option<HtmlElement<HtmlEl>>>) -> Self

Converts to this type from the input type.

impl<HtmlEl> From<RwSignal<Option<HtmlElement<HtmlEl>>>> for ElementMaybeSignal<HtmlElement, HtmlElement>

where HtmlEl: ElementDescriptor + Deref<Target = HtmlElement> + Clone,

fn from(value: RwSignal<Option<HtmlElement<HtmlEl>>>) -> Self

Converts to this type from the input type.

impl<T, E> From<RwSignal<Option<T>>> for ElementMaybeSignal<T, E>

where T: Into<E> + Clone + 'static,

fn from(target: RwSignal<Option<T>>) -> Self

Converts to this type from the input type.

impl<E> From<RwSignal<String>> for ElementMaybeSignal<Element, E>

where E: From<Element> + 'static,

fn from(signal: RwSignal<String>) -> Self

Converts to this type from the input type.

impl<T, E> From<RwSignal<T>> for ElementMaybeSignal<T, E>

where T: Into<E> + Clone + 'static,

fn from(signal: RwSignal<T>) -> Self

Converts to this type from the input type.

impl<E> From<Signal<&str>> for ElementMaybeSignal<Element, E>

where E: From<Element> + 'static,

fn from(signal: Signal<&str>) -> Self

Converts to this type from the input type.

impl<HtmlEl> From<Signal<HtmlElement<HtmlEl>>> for ElementMaybeSignal<Element, Element>

where HtmlEl: ElementDescriptor + Deref<Target = Element> + Clone,

fn from(value: Signal<HtmlElement<HtmlEl>>) -> Self

Converts to this type from the input type.

impl<HtmlEl> From<Signal<HtmlElement<HtmlEl>>> for ElementMaybeSignal<EventTarget, EventTarget>

where HtmlEl: ElementDescriptor + Deref<Target = EventTarget> + Clone,

fn from(value: Signal<HtmlElement<HtmlEl>>) -> Self

Converts to this type from the input type.

impl<HtmlEl> From<Signal<Option<HtmlElement<HtmlEl>>>> for ElementMaybeSignal<Element, Element>

where HtmlEl: ElementDescriptor + Deref<Target = Element> + Clone,

fn from(value: Signal<Option<HtmlElement<HtmlEl>>>) -> Self

Converts to this type from the input type.

impl<HtmlEl> From<Signal<Option<HtmlElement<HtmlEl>>>> for ElementMaybeSignal<EventTarget, EventTarget>

where HtmlEl: ElementDescriptor + Deref<Target = EventTarget> + Clone,

fn from(value: Signal<Option<HtmlElement<HtmlEl>>>) -> Self

Converts to this type from the input type.

impl<HtmlEl> From<Signal<Option<HtmlElement<HtmlEl>>>> for ElementMaybeSignal<HtmlElement, HtmlElement>

where HtmlEl: ElementDescriptor + Deref<Target = HtmlElement> + Clone,

fn from(value: Signal<Option<HtmlElement<HtmlEl>>>) -> Self

Converts to this type from the input type.

impl<T, E> From<Signal<Option<T>>> for ElementMaybeSignal<T, E>

where T: Into<E> + Clone + 'static,

fn from(target: Signal<Option<T>>) -> Self

Converts to this type from the input type.

impl<E> From<Signal<String>> for ElementMaybeSignal<Element, E>

where E: From<Element> + 'static,

fn from(signal: Signal<String>) -> Self

Converts to this type from the input type.

impl<T, E> From<Signal<T>> for ElementMaybeSignal<T, E>

where T: Into<E> + Clone + 'static,

fn from(signal: Signal<T>) -> Self

Converts to this type from the input type.

impl<E> From<String> for ElementMaybeSignal<Element, E>

where E: From<Element> + 'static,

fn from(target: String) -> Self

Converts to this type from the input type.

impl<T, E> From<T> for ElementMaybeSignal<T, E>

where T: Into<E> + Clone + 'static,

fn from(value: T) -> Self

Converts to this type from the input type.

impl<E> From<UseDocument> for ElementMaybeSignal<Document, E>

where E: From<Document> + 'static,

fn from(value: UseDocument) -> Self

Converts to this type from the input type.

impl<E> From<UseWindow> for ElementMaybeSignal<Window, E>

where E: From<Window> + 'static,

fn from(value: UseWindow) -> Self

Converts to this type from the input type.

impl<T, E> SignalGet for ElementMaybeSignal<T, E>

where T: Into<E> + Clone + 'static,

type Value = Option<T>

The value held by the signal.

fn get(&self) -> Option<T>

Clones and returns the current value of the signal, and subscribes the running effect to this signal.

fn try_get(&self) -> Option<Option<T>>

Clones and returns the signal value, returning Some if the signal is still alive, and None otherwise.

impl<T, E> SignalGetUntracked for ElementMaybeSignal<T, E>

where T: Into<E> + Clone + 'static,

type Value = Option<T>

The value held by the signal.

fn get_untracked(&self) -> Option<T>

Gets the signal’s value without creating a dependency on the current scope.

fn try_get_untracked(&self) -> Option<Option<T>>

Gets the signal’s value without creating a dependency on the current scope. Returns [Some(T)] if the signal is still valid, None otherwise.

impl<T, E> SignalWith for ElementMaybeSignal<T, E>

where T: Into<E> + Clone + 'static,

type Value = Option<T>

The value held by the signal.

fn with<O>(&self, f: impl FnOnce(&Option<T>) -> O) -> O

Applies a function to the current value of the signal, and subscribes the running effect to this signal.

fn try_with<O>(&self, f: impl FnOnce(&Option<T>) -> O) -> Option<O>

Applies a function to the current value of the signal, and subscribes the running effect to this signal. Returns Some if the signal is valid and the function ran, otherwise returns None.

fn track(&self)

Subscribes to this signal in the current reactive scope without doing anything with its value.

impl<T, E> SignalWithUntracked for ElementMaybeSignal<T, E>

where T: Into<E> + Clone + 'static,

type Value = Option<T>

The value held by the signal.

fn with_untracked<O>(&self, f: impl FnOnce(&Option<T>) -> O) -> O

Runs the provided closure with a reference to the current value without creating a dependency on the current scope.

fn try_with_untracked<O>(&self, f: impl FnOnce(&Option<T>) -> O) -> Option<O>

Runs the provided closure with a reference to the current value without creating a dependency on the current scope. Returns [Some(O)] if the signal is still valid, None otherwise.