Struct ResourceViewSpec 

pub struct ResourceViewSpec {
    pub id: String,
    pub label: String,
    pub description: Option<String>,
    pub open_action: String,
    pub primary: bool,
    pub mount: Option<ResourceViewMountSpec>,
    pub range: Option<ResourceViewRangeSpec>,
}

An explicit presentation of a resource, separate from the actions used to open or mount it.

id is the stable view identity. open_action and the optional mount action are execution bindings and may change without turning every local OperationKind::View action into an advertised resource view.

Fields

id: String

label: String

description: Option<String>

open_action: String

primary: bool

mount: Option<ResourceViewMountSpec>

range: Option<ResourceViewRangeSpec>

Implementations

impl ResourceViewSpec

pub fn new( id: impl Into<String>, label: impl Into<String>, open_action: impl Into<String>, ) -> ResourceViewSpec

pub fn with_description( self, description: impl Into<String>, ) -> ResourceViewSpec

pub fn with_primary(self, primary: bool) -> ResourceViewSpec

pub fn with_mount(self, mount: ResourceViewMountSpec) -> ResourceViewSpec

pub fn with_range(self, range: ResourceViewRangeSpec) -> ResourceViewSpec

pub fn validate(&self, resource: &Resource) -> Vec<String>

Validate this declaration against the actions exported by resource.

Cross-view invariants such as unique open actions and a single primary view are checked by crate::validate_surface_contracts.

Trait Implementations

impl Clone for ResourceViewSpec

fn clone(&self) -> ResourceViewSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResourceViewSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResourceViewSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ResourceViewSpec

fn eq(&self, other: &ResourceViewSpec) -> 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 ResourceViewSpec

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 ResourceViewSpec

impl StructuralPartialEq for ResourceViewSpec