Struct SurfaceDescriptorBuilder 

pub struct SurfaceDescriptorBuilder { /* private fields */ }

Builder for SurfaceDescriptor.

Obtain an instance via SurfaceDescriptor::builder and call build to finalise the descriptor. Optional fields (required_permission and context_selector) default to None.

build panics if any required field has not been set.

Implementations

impl SurfaceDescriptorBuilder

pub fn surface_id(self, surface_id: SurfaceId) -> SurfaceDescriptorBuilder

Sets the surface identifier.

pub fn label(self, label: impl Into<String>) -> SurfaceDescriptorBuilder

Sets the human-readable label.

pub fn priority(self, priority: i32) -> SurfaceDescriptorBuilder

Sets the display priority within the slot.

pub fn slot(self, slot: impl Into<String>) -> SurfaceDescriptorBuilder

Sets the slot identifier (e.g. "surface.page").

pub fn scope(self, scope: Scope) -> SurfaceDescriptorBuilder

Sets the scope (global or tenant).

pub fn targeting(self, targeting: Targeting) -> SurfaceDescriptorBuilder

Sets the targeting mode.

pub fn required_permission( self, permission: impl Into<String>, ) -> SurfaceDescriptorBuilder

Sets the permission string required to view this surface (optional).

pub fn provider_kind( self, provider_kind: ProviderKind, ) -> SurfaceDescriptorBuilder

Sets the provider kind.

pub fn required_capabilities( self, required_capabilities: CapabilitySet, ) -> SurfaceDescriptorBuilder

Sets the set of capabilities this surface requires from the framework.

pub fn root_node(self, root_node: SurfaceNode) -> SurfaceDescriptorBuilder

Sets the root SurfaceNode of the surface layout.

pub fn context_selector( self, context_selector: SurfaceContextSelectorDescriptor, ) -> SurfaceDescriptorBuilder

Attaches a context-selector dropdown descriptor to the surface (optional).

pub fn nav_icon(self, nav_icon: impl Into<String>) -> SurfaceDescriptorBuilder

Sets the nav icon name (optional; must match a key in the frontend SURFACE_NAV_ICONS allowlist).

pub fn tab_group( self, id: impl Into<String>, label: impl Into<String>, ) -> SurfaceDescriptorBuilder

Groups this surface with others sharing id under one settings tab.

If id matches an existing built-in tab (e.g. "general"), content is appended to that tab and label is ignored. Otherwise a new tab labelled label is created.

pub fn build(self) -> SurfaceDescriptor

Consumes the builder and returns the SurfaceDescriptor.

Panics

Panics if any required field (surface_id, label, priority, slot, scope, targeting, provider_kind, required_capabilities, root_node) has not been set.

Trait Implementations

impl Clone for SurfaceDescriptorBuilder

fn clone(&self) -> SurfaceDescriptorBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SurfaceDescriptorBuilder

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

Formats the value using the given formatter.

impl Default for SurfaceDescriptorBuilder

fn default() -> SurfaceDescriptorBuilder

Returns the “default value” for a type.