Struct SurfaceDescriptor 

#[non_exhaustive]
pub struct SurfaceDescriptor {

    pub surface_id: SurfaceId,
    pub label: String,
    pub priority: i32,
    pub slot: String,
    pub scope: Scope,
    pub targeting: Targeting,
    pub required_action: Option<String>,
    pub provider_kind: ProviderKind,
    pub required_capabilities: CapabilitySet,
    pub root_node: SurfaceNode,
    pub context_selector: Option<SurfaceContextSelectorDescriptor>,
    pub nav_icon: Option<String>,
    pub tab_group: Option<String>,
    pub tab_group_label: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

surface_id: SurfaceId

label: String

priority: i32

slot: String

scope: Scope

targeting: Targeting

required_action: Option<String>

Canonical action string (resource:verb) required to view/use this surface; parsed to Action at admission.

provider_kind: ProviderKind

required_capabilities: CapabilitySet

root_node: SurfaceNode

context_selector: Option<SurfaceContextSelectorDescriptor>

nav_icon: Option<String>

tab_group: Option<String>

tab_group_label: Option<String>

Implementations

impl SurfaceDescriptor

pub fn builder() -> SurfaceDescriptorBuilder

Returns a zero-arg SurfaceDescriptorBuilder for constructing a SurfaceDescriptor.

Example

use uptrakit_surfaces::{
    CapabilitySet, ProviderKind, Scope, SurfaceDescriptor, SurfaceId, SurfaceNode, Targeting,
};

let descriptor = SurfaceDescriptor::builder()
    .surface_id(SurfaceId::new("provider.sample.surface").unwrap())
    .label("Sample")
    .priority(200)
    .slot("surface.page")
    .scope(Scope::Tenant)
    .targeting(Targeting::Universal)
    .provider_kind(ProviderKind::Plugin)
    .required_capabilities(CapabilitySet::default())
    .root_node(SurfaceNode::section(None::<String>, vec![]))
    .build();

Trait Implementations

impl Clone for SurfaceDescriptor

fn clone(&self) -> SurfaceDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SurfaceDescriptor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SurfaceDescriptor

fn deserialize<__D>( __deserializer: __D, ) -> Result<SurfaceDescriptor, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SurfaceDescriptor

impl PartialEq for SurfaceDescriptor

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SurfaceDescriptor

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SurfaceDescriptor