Struct WorkspaceOpenHandoffBuilder 

pub struct WorkspaceOpenHandoffBuilder { /* private fields */ }

Builder for a checked project/file open handoff.

Implementations

impl WorkspaceOpenHandoffBuilder

pub fn new() -> Self

Create an empty workspace-open handoff builder.

pub fn paths(paths: impl IntoIterator<Item = impl Into<PathBuf>>) -> Self

Create a builder from paths.

pub fn intake(self, intake: FileIntakePlanBuilder) -> Self

Use an already configured file-intake builder.

pub fn path(self, path: impl Into<PathBuf>) -> Self

Add one opened path.

pub fn with_paths( self, paths: impl IntoIterator<Item = impl Into<PathBuf>>, ) -> Self

Add multiple opened paths.

pub fn max_paths(self, max_paths: usize) -> Self

Limit the number of opened paths.

pub fn require_existing_paths(self) -> Self

Require all paths to exist. This is the default.

pub fn allow_missing_paths(self) -> Self

Allow virtual or not-yet-created paths.

pub fn canonicalize_paths(self) -> Self

Canonicalize paths before building the handoff.

pub fn reject_unknown(self) -> Self

Reject unknown file kinds during intake.

pub fn watch_options(self, options: FileWatchOptions) -> Self

Set watcher options for workspace/project roots.

pub fn non_recursive_watch(self) -> Self

Watch workspace/project roots non-recursively.

pub fn recursive_watch(self) -> Self

Watch workspace/project roots recursively with no depth limit.

pub fn watch_depth(self, max_depth: usize) -> Self

Watch workspace/project roots recursively up to a bounded depth.

pub fn without_watchers(self) -> Self

Build the handoff without watcher roots.

pub fn validate(&self) -> Result<()>

Validate the configured intake and watcher options.

pub fn build_checked(self) -> Result<WorkspaceOpenHandoff>

Build the checked workspace-open handoff.

pub fn to_text(&self) -> String

Content-safe summary for generated workspace-open flows.

Trait Implementations

impl Clone for WorkspaceOpenHandoffBuilder

fn clone(&self) -> WorkspaceOpenHandoffBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkspaceOpenHandoffBuilder

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

Formats the value using the given formatter.

impl Default for WorkspaceOpenHandoffBuilder

fn default() -> Self

Returns the “default value” for a type.

impl Eq for WorkspaceOpenHandoffBuilder

impl PartialEq for WorkspaceOpenHandoffBuilder

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for WorkspaceOpenHandoffBuilder