Struct ResourceSpec 

pub struct ResourceSpec {
    pub id: ResourceId,
    pub kind: String,
    pub label: String,
    pub presentation: Option<ResourcePresentation>,
    pub semantic_identity: Option<ResourceSemanticIdentity>,
    pub app_id: Option<String>,
    pub children: Vec<ResourceSpec>,
    pub actions: Vec<ActionSpec>,
    pub views: Vec<ResourceViewSpec>,
    pub readers: Readers,
    pub resource_type: Option<ResourceType>,
}

One open/presented resource and the actions it exports. Resources nest via children.

Fields

id: ResourceId

kind: String

A stable kind tag (e.g. "tube.video", "ebook.annotation"), shared with the global-search type registry for OS-wide enumeration.

label: String

Human, localisable label shown in the palette.

presentation: Option<ResourcePresentation>

Optional shell-rendered metadata used by system search and resource browsers. Invalid or oversized values are omitted at the boundary.

semantic_identity: Option<ResourceSemanticIdentity>

Exact original typed identity retained before host namespacing.

app_id: Option<String>

The app that publishes it, as the ActionKeys of its actions name it: the one whose resource this is, not the provider keeping it in a workspace. None for a resource published outside an app.

children: Vec<ResourceSpec>

actions: Vec<ActionSpec>

views: Vec<ResourceViewSpec>

Explicit presentations of this resource. Actions remain invocation mechanisms; only entries in this collection are resource views.

readers: Readers

Who may read the reading this resource publishes.

resource_type: Option<ResourceType>

What it is, as people name it, when its type says (ResourceType).

Implementations

impl ResourceSpec

pub fn new( id: impl Into<String>, kind: impl Into<String>, label: impl Into<String>, ) -> ResourceSpec

pub fn app(&self) -> Option<&str>

The app that publishes it, as an ActionKey of one of its actions names it (Self::app_id).

pub fn with_presentation( self, presentation: ResourcePresentation, ) -> ResourceSpec

pub fn with_type(self, resource_type: ResourceType) -> ResourceSpec

Saying what it is, as people name it.

pub fn with_action(self, action: ActionSpec) -> ResourceSpec

pub fn with_view(self, view: ResourceViewSpec) -> ResourceSpec

pub fn with_granted_reading(self) -> ResourceSpec

Publish this resource’s reading only to callers the workspace grants it to (Readers::Granted): what the person’s own state needs, when it is theirs alone.

pub fn retain_actions(&mut self, keep: impl FnMut(&ActionSpec) -> bool)

Keep the actions keep admits, and only the views still opened by one of them: a view whose open action is not offered cannot be offered either, and the action contract refuses the whole surface that carries one.

pub fn with_child(self, child: ResourceSpec) -> ResourceSpec

pub fn listed_for_people(&self) -> bool

Whether a palette may list it: a titled resource that offers a person at least one action of its own. An untitled node, a control mirror, and a node left with only agent actions are all addressing machinery, and a list of what a person may act on never shows them.

pub fn person_action_count(&self) -> usize

How many of its actions a person may take.

pub fn open_action(&self) -> Option<&ActionSpec>

The action that presents it, when a person may take it: what a palette lists the resource for.

pub fn with_children( self, children: impl IntoIterator<Item = ResourceSpec>, ) -> ResourceSpec

pub fn action_address(&self, action: &str) -> Option<ActionAddress>

The address of the action action this resource publishes, or None when it publishes none by that id. A caller holding a published resource (a survey’s, a search hit’s, a bound tree’s) addresses its actions from it rather than writing an address of its own, so an action the resource stopped publishing fails here, at the caller.

Trait Implementations

impl Clone for ResourceSpec

fn clone(&self) -> ResourceSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.