moved SpecialVTagKind to feat_ssr, improved its description

yewstack · Aug 20, 2023 · 3bb737a · 3bb737a
1 parent 437d7d9
commit 3bb737a
Show file tree

Hide file tree

Showing 8 changed files with 33 additions and 27 deletions.
diff --git a/packages/yew/src/html/component/scope.rs b/packages/yew/src/html/component/scope.rs
@@ -294,13 +294,14 @@ mod feat_ssr {
  use std::fmt::Write;
 
  use super::*;
+ use crate::feat_ssr::SpecialVTagKind;
  use crate::html::component::lifecycle::{
  ComponentRenderState, CreateRunner, DestroyRunner, RenderRunner,
  };
  use crate::platform::fmt::BufWriter;
  use crate::platform::pinned::oneshot;
+ use crate::scheduler;
  use crate::virtual_dom::Collectable;
- use crate::{scheduler, SpecialVTagKind};
 
  impl<COMP: BaseComponent> Scope<COMP> {
  pub(crate) async fn render_into_stream(

diff --git a/packages/yew/src/server_renderer.rs b/packages/yew/src/server_renderer.rs
@@ -9,27 +9,33 @@ use crate::html::{BaseComponent, Scope};
 use crate::platform::fmt::BufStream;
 use crate::platform::{LocalHandle, Runtime};
 
-/// Passed top-down as context for `render_into_stream` functions to know the current innermost
-/// VTag kind to apply appropriate text escaping.
 #[cfg(feature = "ssr")]
-#[derive(Default, Clone, Copy)]
-pub(crate) enum SpecialVTagKind {
- Style, // <style> tag
- Script, // <script> tag
- #[default]
- Other,
-}
+pub(crate) mod feat_ssr {
+ /// Passed top-down as context for `render_into_stream` functions to know the current innermost
+ /// `VTag` kind to apply appropriate text escaping.
+ /// Right now this is used to make `VText` nodes aware of their environment and correctly
+ /// escape their contents when rendering them during SSR.
+ #[derive(Default, Clone, Copy)]
+ pub(crate) enum SpecialVTagKind {
+ /// <style> tag
+ Style,
+ /// <script> tag
+ Script,
+ #[default]
+ /// any other tag
+ Other,
+ }
 
-#[cfg(feature = "ssr")]
-impl<T: AsRef<str>> From<T> for SpecialVTagKind {
- fn from(value: T) -> Self {
- let value = value.as_ref();
- if value.eq_ignore_ascii_case("style") {
- Self::Style
- } else if value.eq_ignore_ascii_case("script") {
- Self::Script
- } else {
- Self::Other
+ impl<T: AsRef<str>> From<T> for SpecialVTagKind {
+ fn from(value: T) -> Self {
+  let value = value.as_ref();
+  if value.eq_ignore_ascii_case("style") {
+  Self::Style
+ } else if value.eq_ignore_ascii_case("script") {
+  Self::Script
+ } else {
+  Self::Other
+ }
  }
  }
 }

diff --git a/packages/yew/src/virtual_dom/vcomp.rs b/packages/yew/src/virtual_dom/vcomp.rs
@@ -20,7 +20,7 @@ use crate::html::Scoped;
 #[cfg(any(feature = "ssr", feature = "csr"))]
 use crate::html::{AnyScope, Scope};
 #[cfg(feature = "ssr")]
-use crate::{platform::fmt::BufWriter, SpecialVTagKind};
+use crate::{feat_ssr::SpecialVTagKind, platform::fmt::BufWriter};
 
 /// A virtual component.
 pub struct VComp {
@@ -256,7 +256,6 @@ impl<COMP: BaseComponent> fmt::Debug for VChild<COMP> {
 mod feat_ssr {
  use super::*;
  use crate::html::AnyScope;
- use crate::SpecialVTagKind;
 
  impl VComp {
  #[inline]

diff --git a/packages/yew/src/virtual_dom/vlist.rs b/packages/yew/src/virtual_dom/vlist.rs
@@ -182,9 +182,9 @@ mod feat_ssr {
  use futures::{join, pin_mut, poll, FutureExt};
 
  use super::*;
+ use crate::feat_ssr::SpecialVTagKind;
  use crate::html::AnyScope;
  use crate::platform::fmt::{self, BufWriter};
- use crate::SpecialVTagKind;
 
  impl VList {
  pub(crate) async fn render_into_stream(

diff --git a/packages/yew/src/virtual_dom/vnode.rs b/packages/yew/src/virtual_dom/vnode.rs
@@ -194,9 +194,9 @@ mod feat_ssr {
  use futures::future::{FutureExt, LocalBoxFuture};
 
  use super::*;
+ use crate::feat_ssr::SpecialVTagKind;
  use crate::html::AnyScope;
  use crate::platform::fmt::BufWriter;
- use crate::SpecialVTagKind;
 
  impl VNode {
  pub(crate) fn render_into_stream<'a>(

diff --git a/packages/yew/src/virtual_dom/vsuspense.rs b/packages/yew/src/virtual_dom/vsuspense.rs
@@ -27,10 +27,10 @@ impl VSuspense {
 #[cfg(feature = "ssr")]
 mod feat_ssr {
  use super::*;
+ use crate::feat_ssr::SpecialVTagKind;
  use crate::html::AnyScope;
  use crate::platform::fmt::BufWriter;
  use crate::virtual_dom::Collectable;
- use crate::SpecialVTagKind;
 
  impl VSuspense {
  pub(crate) async fn render_into_stream(

diff --git a/packages/yew/src/virtual_dom/vtag.rs b/packages/yew/src/virtual_dom/vtag.rs
@@ -451,10 +451,10 @@ mod feat_ssr {
  use std::fmt::Write;
 
  use super::*;
+ use crate::feat_ssr::SpecialVTagKind;
  use crate::html::AnyScope;
  use crate::platform::fmt::BufWriter;
  use crate::virtual_dom::VText;
- use crate::SpecialVTagKind;
 
  // Elements that cannot have any child elements.
  static VOID_ELEMENTS: &[&str; 14] = &[

diff --git a/packages/yew/src/virtual_dom/vtext.rs b/packages/yew/src/virtual_dom/vtext.rs
@@ -44,9 +44,9 @@ mod feat_ssr {
  use std::fmt::Write;
 
  use super::*;
+ use crate::feat_ssr::SpecialVTagKind;
  use crate::html::AnyScope;
  use crate::platform::fmt::BufWriter;
- use crate::SpecialVTagKind;
 
  impl VText {
  pub(crate) async fn render_into_stream(