Struct WorkspaceFile 

pub struct WorkspaceFile { /* private fields */ }

Safe wrapper for TestStand™ WorkspaceFile (IWorkspaceFile).

Implementations

impl WorkspaceFile

pub fn as_property_object_file(&self) -> Result<PropertyObjectFile, Error>

The workspace seen as a property-object file (AsPropertyObjectFile).

A workspace is a file like any other underneath, so this is the route to its stored data and its registered types.

Errors

Error if the COM call fails or returns an unexpected type.

pub fn root_workspace_object(&self) -> Result<WorkspaceObject, Error>

Accesses the root workspace object (WorkspaceFile.RootWorkspaceObject).

Errors

Error if the COM call fails or returns an unexpected type.

Examples found in repository

examples/workspace_create.rs (line 10)

fn main() -> Result<(), rs_teststand::Error> {
    let engine = Engine::new()?;

    println!("Creating a new workspace file...");
    let ws_file = engine.new_workspace_file()?;
    let root_obj = ws_file.root_workspace_object()?;

    println!("Root workspace object:");
    println!("  Display Name: '{}'", root_obj.display_name()?);
    println!("  Object Type: {}", root_obj.object_type()?);
    println!("  Child Objects: {}", root_obj.num_contained_objects()?);

    println!("\nCreating project and folder structure...");
    let project = root_obj.new_folder("Project Alpha")?;
    println!("  Created project folder: '{}'", project.display_name()?);

    let seq_entry = project.new_file("MainTest.seq")?;
    println!(
        "  Created sequence file entry: '{}'",
        seq_entry.display_name()?
    );

    println!(
        "\nUpdated root child objects count: {}",
        root_obj.num_contained_objects()?
    );

    Ok(())
}

pub fn provider_name(&self) -> Result<Option<String>, Error>

The source code control provider this workspace names (WorkspaceFile.ProviderName).

Three states, all distinct:

• None, the workspace names no provider.
• Some(""), defer to the system default provider.
• Some(name), that named provider.

Errors

Error if the COM call fails or returns an unexpected type.

pub fn set_provider_name(&self, name: &str) -> Result<(), Error>

Names the source code control provider (WorkspaceFile.ProviderName).

Pass an empty string to defer to the system default provider.

Errors

Error if the COM call fails.

pub fn is_connected_to_sc_provider(&self) -> Result<bool, Error>

Whether this workspace is connected to a source code control provider (WorkspaceFile.IsConnectedToSCProvider).

Connection is a side effect of the engine adopting the workspace, not something this type performs, so a freshly opened file can report false until the engine takes it as the current workspace.

Errors

Error if the COM call fails or returns an unexpected type.

pub fn save_workspace_and_project_files( &self, options: i32, ) -> Result<bool, Error>

Writes the workspace and its projects to disk if they have been modified (WorkspaceFile.SaveWorkspaceAndProjectFiles).

This method can raise a dialog and is therefore unsafe on an unattended host. When there are modifications it asks the user before writing, and a false return means precisely that they declined, not that the save failed. Nothing is prompted or written when nothing has changed. A failure to write is reported as an error naming the files, not as false.

Engine-level dialog suppression does not cover this one; it is a deliberate confirmation, not a configurable prompt. Guard the call with a Watchdog if a service must make it at all.

Errors

Error if the COM call fails or any file cannot be written.

pub fn find_workspace_object( &self, path: &str, ) -> Result<Option<WorkspaceObject>, Error>

Finds a workspace object by lookup path (WorkspaceFile.FindWorkspaceObject).

Errors

Error if the COM call fails or returns an unexpected type.

Trait Implementations

impl Debug for WorkspaceFile

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

Formats the value using the given formatter.