Struct WorkspaceObject 

pub struct WorkspaceObject { /* private fields */ }

Safe wrapper for TestStand™ WorkspaceObject (IWorkspaceObject).

Implementations

impl WorkspaceObject

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

Reads display name (WorkspaceObject.DisplayName).

Errors

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

Examples found in repository

examples/workspace_create.rs (line 13)

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 set_display_name(&self, value: &str) -> Result<(), Error>

Writes display name (WorkspaceObject.DisplayName).

Errors

Error if the COM call fails.

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

Reads relative path (WorkspaceObject.Path).

Errors

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

pub fn set_path(&self, value: &str) -> Result<(), Error>

Writes relative path (WorkspaceObject.Path).

Errors

Error if the COM call fails.

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

Reads file exists status (WorkspaceObject.FileExists).

Errors

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

pub fn object_type(&self) -> Result<i32, Error>

Reads object type discriminant (WorkspaceObject.ObjectType).

Errors

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

Examples found in repository

examples/workspace_create.rs (line 14)

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 num_contained_objects(&self) -> Result<i32, Error>

Reads number of contained child objects (WorkspaceObject.NumContainedObjects).

Errors

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

Examples found in repository

examples/workspace_create.rs (line 15)

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 get_contained_object(&self, index: i32) -> Result<Self, Error>

Retrieves a contained child object by 0-based index (WorkspaceObject.GetContainedObject).

Errors

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

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

Reads absolute file path (WorkspaceObject.GetAbsolutePath).

Errors

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

pub fn new_file(&self, path_string: &str) -> Result<Self, Error>

Creates a new child file object (WorkspaceObject.NewFile).

Errors

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

Examples found in repository

examples/workspace_create.rs (line 21)

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 new_folder(&self, folder_name: &str) -> Result<Self, Error>

Creates a new child folder object (WorkspaceObject.NewFolder).

Errors

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

Examples found in repository

examples/workspace_create.rs (line 18)

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 remove_object(&self, index: i32) -> Result<Self, Error>

Removes a child object by index (WorkspaceObject.RemoveObject).

Errors

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

Trait Implementations

impl Debug for WorkspaceObject

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

Formats the value using the given formatter.