Struct Package 

pub struct Package {

    pub name: String,
    pub version: Option<Version>,
    pub description: Option<String>,
    pub authors: Vec<String>,
    pub requires: Vec<String>,
    pub build_requires: Vec<String>,
    pub private_build_requires: Vec<String>,
    pub variants: Vec<Vec<String>>,
    pub tools: Vec<String>,
    pub commands: Option<String>,
    pub commands_function: Option<String>,
    pub build_command: Option<String>,
    pub build_system: Option<String>,
    pub pre_commands: Option<String>,
    pub post_commands: Option<String>,
    pub pre_test_commands: Option<String>,
    pub pre_build_commands: Option<String>,
    pub tests: HashMap<String, String>,
    pub requires_rez_version: Option<String>,
    pub uuid: Option<String>,
    pub config: HashMap<String, String>,
    pub help: Option<String>,
    pub relocatable: Option<bool>,
    pub cachable: Option<bool>,
    pub timestamp: Option<i64>,
    pub revision: Option<String>,
    pub changelog: Option<String>,
    pub release_message: Option<String>,
    pub previous_version: Option<Version>,
    pub previous_revision: Option<String>,
    pub vcs: Option<String>,
    pub format_version: Option<i32>,
    pub base: Option<String>,
    pub has_plugins: Option<bool>,
    pub plugin_for: Vec<String>,
    pub hashed_variants: Option<bool>,
    pub preprocess: Option<String>,
    pub is_dev_package: Option<bool>,
    pub filepath: Option<String>,
    pub includes: Option<HashSet<String>>,
}

High-performance package representation compatible with rez

Fields

name: String

Package name

version: Option<Version>

Package version

description: Option<String>

Package description

authors: Vec<String>

Package authors

requires: Vec<String>

Package requirements

build_requires: Vec<String>

Build requirements

private_build_requires: Vec<String>

Private build requirements

variants: Vec<Vec<String>>

Package variants

tools: Vec<String>

Package tools

commands: Option<String>

Package commands (rex script string, set from def commands(): body)

commands_function: Option<String>

Package commands function body (alias for commands; used by validation layer)

build_command: Option<String>

Build command for custom builds

build_system: Option<String>

Build system type

pre_commands: Option<String>

Pre commands (executed before main commands)

post_commands: Option<String>

Post commands (executed after main commands)

pre_test_commands: Option<String>

Pre test commands (executed before tests)

pre_build_commands: Option<String>

Pre build commands (executed before build)

tests: HashMap<String, String>

Package tests

requires_rez_version: Option<String>

Required rez version

uuid: Option<String>

Package UUID

config: HashMap<String, String>

Package config

help: Option<String>

Package help

relocatable: Option<bool>

Package relocatable flag

cachable: Option<bool>

Package cachable flag

timestamp: Option<i64>

Package timestamp

revision: Option<String>

Package revision

changelog: Option<String>

Package changelog

release_message: Option<String>

Package release message

previous_version: Option<Version>

Previous version

previous_revision: Option<String>

Previous revision

vcs: Option<String>

VCS type

format_version: Option<i32>

Package format version

base: Option<String>

Package base

has_plugins: Option<bool>

Package has plugins

plugin_for: Vec<String>

Plugin for packages

hashed_variants: Option<bool>

Package hashed variants

preprocess: Option<String>

Package preprocess function

is_dev_package: Option<bool>

Whether this is a developer package (loaded from a working directory)

filepath: Option<String>

File path to the package definition file (package.py or package.yaml)

includes: Option<HashSet<String>>

Set of included Python modules (from @include decorators)

Implementations

impl Package

pub fn new(name: String) -> Self

pub fn qualified_name(&self) -> String

Get the qualified name of the package (name-version)

pub fn as_exact_requirement(&self) -> String

Get the package as an exact requirement string

pub fn is_package(&self) -> bool

Check if this is a package (always true for Package)

pub fn is_variant(&self) -> bool

Check if this is a variant (always false for Package)

pub fn num_variants(&self) -> usize

Get the number of variants

pub fn set_version(&mut self, version: Version)

Set the package version

pub fn set_description(&mut self, description: String)

Set the package description

pub fn add_author(&mut self, author: String)

Add an author

pub fn add_requirement(&mut self, requirement: String)

Add a requirement

pub fn add_build_requirement(&mut self, requirement: String)

Add a build requirement

pub fn add_private_build_requirement(&mut self, requirement: String)

Add a private build requirement

pub fn add_variant(&mut self, variant: Vec<String>)

Add a variant

pub fn add_tool(&mut self, tool: String)

Add a tool

pub fn set_commands(&mut self, commands: String)

Set commands

pub fn is_valid(&self) -> bool

Check if the package definition is valid

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

Validate the package definition

pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Self, RezCoreError>

Load a developer package from a path.

This aligns with Rez’s DeveloperPackage.from_path() interface. Supports both file path (package.py/package.yaml) and directory path.

Arguments

• path - Directory containing package definition, or path to the file itself

Returns

• Result<Package, RezCoreError> - The loaded package

Example

let pkg = Package::from_path(pkg_path).unwrap();
assert_eq!(pkg.name, "mypackage");

pub fn root(&self) -> Option<String>

Get the root directory of the package (parent of filepath).

Aligns with Rez’s DeveloperPackage.root property.

pub fn to_package_py(&self) -> String

Serialize the package to package.py format string. Compatible with rez package.py format.

Trait Implementations

impl Clone for Package

fn clone(&self) -> Package

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Package

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

Formats the value using the given formatter.

impl Default for Package

fn default() -> Package

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Package

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Package

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.