Struct PlatformDirectory

pub struct PlatformDirectory { /* private fields */ }

Represents an Apple Platform directory.

This is just a thin abstraction over a filesystem path and a Platform instance.

Equivalence and sorting are implemented in terms of the path component only. The assumption here is the Platform is fully derived from the filesystem path and this derivation is deterministic.

Implementations

impl PlatformDirectory

pub fn from_path(path: impl AsRef<Path>) -> Result<Self, Error>

Attempt to construct an instance from a filesystem path.

pub fn path(&self) -> &Path

The filesystem path of this instance.

pub fn sdks_path(&self) -> PathBuf

The filesystem path to the directory holding SDKs.

The returned path is not validated to exist.

pub fn find_sdks<T: AppleSdk>(&self) -> Result<Vec<T>, Error>

Finds SDKs in this platform directory.

The type of SDK to resolve must be specified by the caller.

This function is a simple wrapper around AppleSdk::find_in_directory() looking under the Developer/SDKs directory, which is where SDKs are located in platform directories.

Methods from Deref<Target = Platform>

pub fn filesystem_name(&self) -> &str

Obtain the name of this platform as used in filesystem paths.

This is just the platform part of the name without the trailing .platform. This string appears in the *.platform directory names as well as in SDK directory names preceding the trailing .sdk and optional SDK version.

pub fn directory_name(&self) -> String

Obtain the directory name of this platform.

This simply appends .platform to Self::filesystem_name().

pub fn path_in_developer_directory( &self, developer_directory: impl AsRef<Path>, ) -> PathBuf

Obtain the path of this platform relative to a developer directory root.

Trait Implementations

impl AsRef<Path> for PlatformDirectory

fn as_ref(&self) -> &Path

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

impl AsRef<Platform> for PlatformDirectory

fn as_ref(&self) -> &Platform

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

impl Deref for PlatformDirectory

type Target = Platform

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Ord for PlatformDirectory

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PlatformDirectory

fn eq(&self, other: &Self) -> 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 PartialOrd for PlatformDirectory

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for PlatformDirectory