Struct SurfaceContextSelectorDescriptor 

#[non_exhaustive]
pub struct SurfaceContextSelectorDescriptor {
    pub param_key: String,
    pub label: String,
    pub all_option_label: String,
    pub rest_api_path: String,
    pub value_field: String,
    pub label_field: String,
    pub required_for_interactions: Vec<InteractionId>,
}

Describes a context-selector dropdown rendered above a surface’s content.

When present on a SurfaceDescriptor, SurfaceReadPanel fetches the options from rest_api_path and renders a ProviderSelector above the surface content. The selected value is merged into baseParams under param_key, driving both the table data load and optional interaction gates.

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.

param_key: String

Param key injected into baseParams when a specific option is selected.

label: String

Label shown above the selector dropdown.

all_option_label: String

Label for the “show all” option (no param injected).

rest_api_path: String

REST API path returning a JSON array or paginated items list.

value_field: String

Field in each item used as the option value.

label_field: String

Field in each item used as the option label.

required_for_interactions: Vec<InteractionId>

Interaction IDs disabled (with tooltip) when no specific option is selected.

Implementations

impl SurfaceContextSelectorDescriptor

pub fn new( param_key: impl Into<String>, label: impl Into<String>, all_option_label: impl Into<String>, rest_api_path: impl Into<String>, value_field: impl Into<String>, label_field: impl Into<String>, required_for_interactions: Vec<InteractionId>, ) -> SurfaceContextSelectorDescriptor

Constructs a new SurfaceContextSelectorDescriptor.

Required because the struct is #[non_exhaustive] — external crates cannot use struct literal syntax and must call this constructor instead.

Trait Implementations

impl Clone for SurfaceContextSelectorDescriptor

fn clone(&self) -> SurfaceContextSelectorDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SurfaceContextSelectorDescriptor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SurfaceContextSelectorDescriptor

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SurfaceContextSelectorDescriptor

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for SurfaceContextSelectorDescriptor

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 Eq for SurfaceContextSelectorDescriptor

impl StructuralPartialEq for SurfaceContextSelectorDescriptor