Struct DeveloperDirectory

pub struct DeveloperDirectory { /* private fields */ }

A directory containing Apple platforms, SDKs, and other tools.

Implementations

impl DeveloperDirectory

pub fn from_env() -> Result<Option<Self>, Error>

Resolve an instance from the DEVELOPER_DIR environment variable.

This environment variable is used by convention to override default search locations for the developer directory.

If DEVELOPER_DIR is defined, the value/path is validated for existence and an error is returned if it doesn’t exist.

If DEVELOPER_DIR isn’t defined, returns Ok(None).

pub fn from_xcode_select_paths() -> Result<Option<Self>, Error>

Attempt to resolve an instance by checking the paths that xcode-select --switch configures. If there is no path configured, this returns None.

This checks, in order:

• The path pointed to by /var/db/xcode_select_link.
• The path pointed to by /usr/share/xcode-select/xcode_dir_link (legacy, previously created by xcode-select).
• The path stored in /usr/share/xcode-select/xcode_dir_path (legacy, previously created by xcode-select).

There are no sources available for xcode-select, so we do not know if these are the only paths that xcode-select uses. We can be fairly sure, though, since the logic has been reverse-engineered several times.

The exact list of paths that apple-sdk searches here is an implementation detail, and may change in the future (e.g. if xcode-select is changed to use a different set of paths).

pub fn from_xcode_select() -> Result<Self, Error>

Attempt to resolve an instance by running xcode-select.

The output from xcode-select is implicitly trusted and no validation of the path is performed.

pub fn default_xcode() -> Option<Self>

Attempt to resolve an instance from the default Xcode.app location.

This looks for a system installed Xcode.app and for the developer directory within. If found, returns Some. If not, returns None.

pub fn find_system_xcodes() -> Result<Vec<Self>, Error>

Finds all Developer directories for system installed Xcode applications.

This is a convenience method for find_system_xcode_applications() plus resolving the Developer directory and filtering on missing items.

It will return all available Developer directories for all Xcode installs under /Applications.

pub fn find_default() -> Result<Option<Self>, Error>

Attempt to find a Developer Directory using reasonable semantics.

This is probably what most end-users want to use for resolving the path to a Developer Directory.

This is a convenience function for calling other APIs on this type to resolve the default instance.

In priority order:

1. DEVELOPER_DIR
2. System Xcode.app application.
3. xcode-select output.

Errors only if DEVELOPER_DIR is defined and it points to an invalid path. Errors from running xcode-select are ignored.

pub fn find_default_required() -> Result<Self, Error>

Find the Developer Directory and error if not found.

This is a wrapper around Self::find_default() that will error if no Developer Directory could be found.

pub fn path(&self) -> &Path

The filesystem path to this developer directory.

pub fn platforms_path(&self) -> PathBuf

The path to the directory containing platforms.

pub fn platforms(&self) -> Result<Vec<PlatformDirectory>, Error>

Find platform directories within this developer directory.

Platforms are defined by the presence of a Platforms directory under the developer directory. This directory layout is only recognized for modern Xcode layouts.

Returns all discovered instances inside this developer directory.

The return order is sorted and deterministic.

pub fn sdks<SDK: AppleSdk>(&self) -> Result<Vec<SDK>, Error>

Find SDKs within this developer directory.

This is a convenience method for calling Self::platforms() + PlatformDirectory::find_sdks() and chaining the results.

Trait Implementations

impl AsRef<Path> for DeveloperDirectory

fn as_ref(&self) -> &Path

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for DeveloperDirectory

fn clone(&self) -> DeveloperDirectory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DeveloperDirectory

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

Formats the value using the given formatter.

impl From<&Path> for DeveloperDirectory

fn from(p: &Path) -> Self

Converts to this type from the input type.

impl From<&PathBuf> for DeveloperDirectory

fn from(path: &PathBuf) -> Self

Converts to this type from the input type.

impl From<PathBuf> for DeveloperDirectory

fn from(path: PathBuf) -> Self

Converts to this type from the input type.

impl PartialEq for DeveloperDirectory

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for DeveloperDirectory

impl StructuralPartialEq for DeveloperDirectory