This is unreleased documentation for Yew Next version.
For up-to-date documentation, see the latest version on docs.rs.
yew::virtual_dom

Enum VNode

source
pub enum VNode {
    VTag(Rc<VTag>),
    VText(VText),
    VComp(Rc<VComp>),
    VList(Rc<VList>),
    VPortal(Rc<VPortal>),
    VRef(Node),
    VSuspense(Rc<VSuspense>),
    VRaw(VRaw),
}
Expand description

Bind virtual element to a DOM reference.

Variants§

§

VTag(Rc<VTag>)

A bind between VTag and Element.

§

VText(VText)

A bind between VText and TextNode.

§

VComp(Rc<VComp>)

A bind between VComp and Element.

§

VList(Rc<VList>)

A holder for a list of other nodes.

§

VPortal(Rc<VPortal>)

A portal to another part of the document

§

VRef(Node)

A holder for any Node (necessary for replacing node).

§

VSuspense(Rc<VSuspense>)

A suspendible document fragment.

§

VRaw(VRaw)

A raw HTML string, represented by AttrValue.

Also see: VNode::from_html_unchecked

Implementations§

source§

impl VNode

source

pub fn key(&self) -> Option<&Key>

source

pub fn has_key(&self) -> bool

Returns true if the VNode has a key.

source

pub fn to_vlist_mut(&mut self) -> &mut VList

Acquires a mutable reference of current VNode as a VList.

Creates a VList with the current node as the first child if current VNode is not a VList.

source

pub fn from_html_unchecked(html: AttrValue) -> Self

Create a VNode from a string of HTML

§Behavior in browser

In the browser, this function creates an element with the same XML namespace as the parent, sets the passed HTML to its innerHTML and inserts the contents of it into the DOM.

§Behavior on server

When rendering on the server, the contents of HTML are directly injected into the HTML stream.

§Warning

The contents are not sanitized or validated. You, as the developer, are responsible to ensure the HTML string passed to this method are valid and not malicious

§Example
use yew::{html, AttrValue, Html};
let parsed = Html::from_html_unchecked(AttrValue::from("<div>content</div>"));
let _: Html = html! {
    <div>
        {parsed}
    </div>
};

Trait Implementations§

source§

impl Clone for VNode

source§

fn clone(&self) -> VNode

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for VNode

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for VNode

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl<T: ToString> From<T> for VNode

source§

fn from(value: T) -> Self

Converts to this type from the input type.
source§

impl<COMP> From<VChild<COMP>> for VNode
where COMP: BaseComponent,

source§

fn from(vchild: VChild<COMP>) -> Self

Converts to this type from the input type.
source§

impl From<VComp> for VNode

source§

fn from(vcomp: VComp) -> Self

Converts to this type from the input type.
source§

impl From<VList> for VNode

source§

fn from(vlist: VList) -> Self

Converts to this type from the input type.
source§

impl From<VPortal> for VNode

source§

fn from(vportal: VPortal) -> Self

Converts to this type from the input type.
source§

impl From<VSuspense> for VNode

source§

fn from(vsuspense: VSuspense) -> Self

Converts to this type from the input type.
source§

impl From<VTag> for VNode

source§

fn from(vtag: VTag) -> Self

Converts to this type from the input type.
source§

impl From<VText> for VNode

source§

fn from(vtext: VText) -> Self

Converts to this type from the input type.
source§

impl<A: Into<VNode>> FromIterator<A> for VNode

source§

fn from_iter<T: IntoIterator<Item = A>>(iter: T) -> Self

Creates a value from an iterator. Read more
source§

impl ImplicitClone for VNode

§

fn implicit_clone(&self) -> Self

This function is not magic; it is literally defined as Read more
source§

impl IntoPropValue<ChildrenRenderer<VNode>> for VNode

source§

fn into_prop_value(self) -> ChildrenRenderer<VNode>

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for &String

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for &str

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for ()

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for Arc<String>

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for Arc<str>

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for ChildrenRenderer<VNode>

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for Cow<'static, str>

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for AttrValue

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for Option<VNode>

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for Rc<String>

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for Rc<str>

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for String

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl<T> IntoPropValue<VNode> for VChild<T>
where T: BaseComponent,

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for VList

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for VText

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for Vec<VNode>

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for bool

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for char

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for f32

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for f64

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for i128

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for i16

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for i32

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for i64

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for i8

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for isize

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for u128

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for u16

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for u32

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for u64

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for u8

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl IntoPropValue<VNode> for usize

source§

fn into_prop_value(self) -> VNode

Convert self to a value of a Properties struct.
source§

impl PartialEq for VNode

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for VNode

Auto Trait Implementations§

§

impl Freeze for VNode

§

impl !RefUnwindSafe for VNode

§

impl !Send for VNode

§

impl !Sync for VNode

§

impl Unpin for VNode

§

impl !UnwindSafe for VNode

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<!> for T

source§

fn from(t: !) -> T

Converts to this type from the input type.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoPropValue<Option<T>> for T

source§

fn into_prop_value(self) -> Option<T>

Convert self to a value of a Properties struct.
source§

impl<T> IntoPropValue<T> for T

source§

fn into_prop_value(self) -> T

Convert self to a value of a Properties struct.
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more