Struct Workspace 

pub struct Workspace { /* private fields */ }

The folder the actions are confined to.

Implementations

impl Workspace

pub fn new(root: &Path) -> Result<Self>

The folder the actions are confined to; it is canonicalized, so links are resolved once.

Errors

When the folder does not exist, cannot be resolved or is not a folder.

pub fn root(&self) -> &Path

The canonical workspace folder.

pub fn preview(&self, action: &Action) -> Result<Preview, String>

What an action would do, for the approval card. Nothing changes on disk.

Errors

When the action cannot be done as asked (a path outside the workspace, an edit whose text does not match exactly once); the sentence is the one Self::perform would give.

pub fn perform(&self, action: &Action, cancelled: &dyn Fn() -> bool) -> Outcome

Does the action. It never panics: every failure becomes an Outcome with is_error set and a sentence the model can act on. cancelled is asked about every 50 ms while a command runs, and between the files a search reads; when it answers true the command or the search is stopped.

pub fn perform_as_shown( &self, action: &Action, shown: Option<&Preview>, cancelled: &dyn Fn() -> bool, ) -> Outcome

Does the action the person allowed on a card that showed shown. An edit whose file changed since the card was drawn, so that what would be written is no longer what the person saw, is not done: the model is told to read the file again.

pub fn perform_watching( &self, action: &Action, shown: Option<&Preview>, cancelled: &dyn Fn() -> bool, on_tail: &mut dyn FnMut(&str), ) -> Outcome

perform_as_shown, handing the end of a command’s output to on_tail while it runs, at most every tenth of a second, so the person sees it go by.

Trait Implementations

impl Clone for Workspace

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Workspace

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

Formats the value using the given formatter.

impl Eq for Workspace

impl PartialEq for Workspace

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Workspace