Struct OpenWorkspace 

pub struct OpenWorkspace { /* private fields */ }

One workspace the rail can switch to, with its own tabs and its own panel content.

Implementations

impl OpenWorkspace

pub fn new( file: &WorkspaceFile, paths: WorkspacePaths, profiles: Vec<Profile>, ) -> Self

A workspace as its own file describes it, living at paths, offering profiles.

The profiles are every profile of the store, already read: this screen shows profiles and enters their containers, it does not go looking for their definitions. The ones the workspace’s workspace.qcode names come first; any other one is added to the workspace the first time a tab of it is opened, so a profile made after the workspace needs no hand edit to be used in it.

pub fn id(&self) -> &str

The workspace’s identifier, which is also what its containers are named after.

pub fn name(&self) -> &str

The name the person gave the workspace.

pub fn paths(&self) -> &WorkspacePaths

Where the workspace’s folders are.

pub fn profiles(&self) -> &[Profile]

The profiles a new tab can open: every profile of the store, the ones the workspace carries first.

pub fn carries(&self, name: &str) -> bool

Whether the workspace’s workspace.qcode names the profile name.

pub fn tabs(&self) -> &[Tab]

The tabs open in this workspace, in the order they are shown.

pub fn active_tab(&self) -> Option<&Tab>

The open tab, when there is one.

pub fn files(&self) -> &FileManagerState

What the file manager knows about the workspace’s own folder.

pub fn backup_skip(&self) -> &[String]

The folders and files inside the workspace its backup leaves out.

pub fn backs_up_assets(&self) -> bool

Whether the workspace’s backup takes Assets/ too.

pub fn containers(&self) -> &[Container]

The containers of this workspace, as the engine last listed them.

pub fn plan(&self, kind: &TabKind) -> Option<ContainerPlan>

The container a tab of kind enters. A picture, a file in the editor, a PDF and an office document are opened in the workspace’s own container, the one its shell runs in; a Markdown document needs none, and a sound plays in a container made for it each time it plays, which no tab enters.

pub fn program(&self, tab: &Tab, editor: Editor) -> Option<Vec<String>>

What tab runs inside its container: a login shell, the harness of the profile with the arguments that let it work without asking, opening the tab’s conversation when it shows one and a new conversation otherwise, chafa drawing a picture or a page of a PDF, or editor on a file. A PDF whose text is shown runs nothing in a terminal.

pub fn is_bridged(&self) -> bool

Whether the workspace listens for its tabs’ agents.

Trait Implementations

impl Debug for OpenWorkspace

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

Formats the value using the given formatter.