pub struct WebUiProtocol {
pub fragments: HashMap<String, FragmentList>,
pub tokens: Vec<String>,
pub components: HashMap<String, ComponentData>,
pub css_strategy: i32,
pub initial_state_strategy: i32,
pub module_preloads: Vec<String>,
pub component_render_css: String,
pub style_closures: HashMap<String, ComponentStyleClosure>,
pub style_chunks: Vec<StyleChunk>,
pub component_asset_style_preloads: Vec<ComponentAssetStylePreload>,
}Expand description
Root protocol containing all fragment records and build metadata.
Fields§
§fragments: HashMap<String, FragmentList>§tokens: Vec<String>Sorted, deduplicated CSS custom property names used across all components and entry page styles (e.g., “colorBrandBackground”, “spacingMedium”). Only usage via var(–name) is included; local definitions are excluded.
components: HashMap<String, ComponentData>Per-component data keyed by tag name (f-template + CSS).
css_strategy: i32Build-wide CSS delivery strategy. Determines how compiled component resources are installed in each CSS tree.
initial_state_strategy: i32Whether initial SSR metadata contains full state or WebUI component projection. Partial-navigation state remains component-driven.
module_preloads: Vec<String>Ready-to-write <link rel="modulepreload"> hrefs for the shared chunks
that the page’s critical module entries statically import, in the exact
order they must be emitted (largest chunk first).
These chunks are named only inside the entry’s own bytes, so the browser’s preload scanner cannot discover them until it has downloaded and parsed the entry. Emitting them as hints removes that serialization.
Order is load-bearing: preloads are issued in document order over one connection, so a small chunk ahead of a large one delays the long pole. The compiler resolves and sorts these at build time so the handler writes them verbatim with no per-request work.
component_render_css: StringBuild-generated document-level rules for component rendering policies. Empty when no component opts into lazy rendering.
style_closures: HashMap<String, ComponentStyleClosure>Ordered, deduplicated component style resource tags for each Document or component-root CSS tree entry point.
style_chunks: Vec<StyleChunk>Bundled stylesheets in global cascade order. Empty unless the build enabled CSS bundling, in which case every component that owns a style resource belongs to exactly one chunk and handlers deliver chunks instead of individual component resources.
component_asset_style_preloads: Vec<ComponentAssetStylePreload>Build-generated eager metadata for static component asset roots.
Entries are sorted by root tag. Builds without component assets omit the field from the wire.
Implementations§
Source§impl WebUiProtocol
impl WebUiProtocol
Sourcepub fn css_strategy(&self) -> CssStrategy
pub fn css_strategy(&self) -> CssStrategy
Returns the enum value of css_strategy, or the default if the field is set to an invalid enum value.
Sourcepub fn set_css_strategy(&mut self, value: CssStrategy)
pub fn set_css_strategy(&mut self, value: CssStrategy)
Sets css_strategy to the provided enum value.
Sourcepub fn initial_state_strategy(&self) -> InitialStateStrategy
pub fn initial_state_strategy(&self) -> InitialStateStrategy
Returns the enum value of initial_state_strategy, or the default if the field is set to an invalid enum value.
Sourcepub fn set_initial_state_strategy(&mut self, value: InitialStateStrategy)
pub fn set_initial_state_strategy(&mut self, value: InitialStateStrategy)
Sets initial_state_strategy to the provided enum value.
Source§impl WebUiProtocol
impl WebUiProtocol
Sourcepub fn component_uses_shadow_dom(&self, tag_name: &str) -> bool
pub fn component_uses_shadow_dom(&self, tag_name: &str) -> bool
Return whether a component authored a declarative Shadow DOM root.
Sourcepub fn component_style_resource(&self, tag_name: &str) -> Option<&str>
pub fn component_style_resource(&self, tag_name: &str) -> Option<&str>
Return the stored style resource for a component.
Link protocols identify a resource by css_href; Style and Module
protocols retain the compiled CSS bytes. An empty field means that the
component has no paired style resource.
Sourcepub fn style_closure(&self, root: &str) -> Option<&[String]>
pub fn style_closure(&self, root: &str) -> Option<&[String]>
Return a precomputed style closure for root.
Sourcepub fn populate_style_closures(&mut self, entry_fragments: &[&str])
pub fn populate_style_closures(&mut self, entry_fragments: &[&str])
Precompute ordered style-resource closures for entry fragments and every compiled component root.
Traversal is iterative, follows source order, stops at Shadow children and route activation edges, and deduplicates resources at first discovery. Matched route roots install their own stored closures.
Sourcepub fn style_chunk_resource(&self, chunk: u32) -> Option<(&str, &str)>
pub fn style_chunk_resource(&self, chunk: u32) -> Option<(&str, &str)>
Return the delivered style resource for a bundled chunk index.
Mirrors Self::component_style_resource: Link protocols identify a
chunk by css_href, Style and Module protocols carry the concatenated
CSS bytes.
Sourcepub fn style_chunk_members(&self, chunk: u32) -> Option<&[String]>
pub fn style_chunk_members(&self, chunk: u32) -> Option<&[String]>
Return the component tags merged into chunk, in cascade order.
Sourcepub fn style_chunk_index(&self) -> HashMap<&str, u32>
pub fn style_chunk_index(&self) -> HashMap<&str, u32>
Map every component whose stylesheet a bundled chunk already ships to that chunk’s index.
This is the single definition of “already covered by a chunk”, and every
delivery path must agree on it. A closure carries style_chunks only
when the bundler treated it as a root; other closures still list their
members individually, and delivering those members verbatim in a bundled
build re-ships bytes the covering chunk already contains. Resolving a
member through this map instead keeps each closure self-sufficient, so
correctness never depends on which closure happens to install first.
Empty for unbundled builds. Build it once per render: it allocates.
Sourcepub fn style_closure_chunks(&self, root: &str) -> Option<&[u32]>
pub fn style_closure_chunks(&self, root: &str) -> Option<&[u32]>
Return the bundled chunk indices for root, in cascade order.
Empty when the build did not bundle CSS, in which case callers deliver
Self::style_closure component resources individually.
Sourcepub fn style_closure_unit_count(closure: &ComponentStyleClosure) -> usize
pub fn style_closure_unit_count(closure: &ComponentStyleClosure) -> usize
Number of delivery units closure walks, in cascade order.
A closure the bundler treated as a root ships one unit per chunk; every other closure ships one unit per member.
Sourcepub fn style_closure_unit<'a>(
&'a self,
closure: &'a ComponentStyleClosure,
chunk_index: &HashMap<&str, u32>,
position: usize,
) -> Option<StyleClosureUnit<'a>>
pub fn style_closure_unit<'a>( &'a self, closure: &'a ComponentStyleClosure, chunk_index: &HashMap<&str, u32>, position: usize, ) -> Option<StyleClosureUnit<'a>>
Resolve one position of closure to the resource that delivers it.
This is the single walk shared by every delivery path, so all of them
agree on Self::style_chunk_index’s definition of “already covered by
a chunk”. A closure that was not a bundler root uses a chunk only when
the chunk’s complete ordered membership is present; otherwise it falls
back to the individual component resource. chunk_index must come from
that accessor; pass an empty map for an unbundled protocol.
Returns None only when position is out of range. A unit whose
resource is None names a resource the protocol does not hold, which
callers report or skip according to their own delivery contract.
Sourcepub fn new(fragments: WebUIFragmentRecords) -> Self
pub fn new(fragments: WebUIFragmentRecords) -> Self
Create a protocol from fragment records with no CSS tokens.
Sourcepub fn with_tokens(fragments: WebUIFragmentRecords, tokens: Vec<String>) -> Self
pub fn with_tokens(fragments: WebUIFragmentRecords, tokens: Vec<String>) -> Self
Create a protocol from fragment records with CSS tokens.
Source§impl WebUiProtocol
impl WebUiProtocol
Sourcepub fn to_json_pretty(&self) -> Result<String, Error>
pub fn to_json_pretty(&self) -> Result<String, Error>
Serialize protocol to pretty JSON (for debug/inspect output only).
Sourcepub fn to_protobuf(&self) -> Result<Vec<u8>>
pub fn to_protobuf(&self) -> Result<Vec<u8>>
Serialize protocol to protobuf binary format.
Sourcepub fn from_protobuf(bytes: &[u8]) -> Result<Self>
pub fn from_protobuf(bytes: &[u8]) -> Result<Self>
Deserialize protocol from protobuf binary bytes with validation.
Sourcepub fn from_protobuf_file<P: AsRef<Path>>(path: P) -> Result<Self>
pub fn from_protobuf_file<P: AsRef<Path>>(path: P) -> Result<Self>
Read and deserialize a protobuf file with validation.
Trait Implementations§
Source§impl Clone for WebUiProtocol
impl Clone for WebUiProtocol
Source§impl Debug for WebUiProtocol
impl Debug for WebUiProtocol
Source§impl Default for WebUiProtocol
impl Default for WebUiProtocol
Source§impl<'de> Deserialize<'de> for WebUiProtocol
impl<'de> Deserialize<'de> for WebUiProtocol
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl Message for WebUiProtocol
impl Message for WebUiProtocol
Source§fn encoded_len(&self) -> usize
fn encoded_len(&self) -> usize
Source§fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>where
Self: Sized,
fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>where
Self: Sized,
Source§fn encode_to_vec(&self) -> Vec<u8> ⓘwhere
Self: Sized,
fn encode_to_vec(&self) -> Vec<u8> ⓘwhere
Self: Sized,
Source§fn encode_length_delimited(
&self,
buf: &mut impl BufMut,
) -> Result<(), EncodeError>where
Self: Sized,
fn encode_length_delimited(
&self,
buf: &mut impl BufMut,
) -> Result<(), EncodeError>where
Self: Sized,
Source§fn encode_length_delimited_to_vec(&self) -> Vec<u8> ⓘwhere
Self: Sized,
fn encode_length_delimited_to_vec(&self) -> Vec<u8> ⓘwhere
Self: Sized,
Source§fn decode(buf: impl Buf) -> Result<Self, DecodeError>where
Self: Default,
fn decode(buf: impl Buf) -> Result<Self, DecodeError>where
Self: Default,
Source§fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>where
Self: Default,
fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>where
Self: Default,
Source§fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>where
Self: Sized,
fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>where
Self: Sized,
self. Read moreSource§fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>where
Self: Sized,
fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>where
Self: Sized,
self.