Struct ResolvedPathItem 

pub struct ResolvedPathItem { /* private fields */ }

The path item that has been validated and resolved in the config.

Implementations

impl ResolvedPathItem

pub fn key(&self) -> Option<&FieldKey>

The key for the path.

pub fn value(&self) -> &Path

The fully resolved path.

This may not be a fully absolute path because the root can be defined as a variable.

pub fn permission(&self) -> &Permission

The permission for the path.

There should be no inherited permissions at this point unless no permissions have been defined at all. Then it is recommended to have the workspace resolver decide what the “root” permission should be.

pub fn owner(&self) -> &Owner

The owner of the path.

There should be no inherited owner at this point, unless no owner has been defined at all. Then it is recommended to have the workspace resolver decide what the “root” owner should be.

pub fn path_type(&self) -> &PathType

The type of the path.

It is assumed that all of the elements except the last will be directories. If the path is a file, then the workspace resolver should use simple logic to create a file (such as copying and pasting from another location). The file template can use a template engine defined in the create workspace’s IO function.

pub fn deferred(&self) -> bool

Whether the path is deferred or not.

pub fn metadata(&self) -> &HashMap<String, MetadataValue>

Metadata for the workspace resolver.

This could contain anything such as the specific user that owns the path, or the source path to copy and paste the file from.

Trait Implementations

impl Clone for ResolvedPathItem

fn clone(&self) -> ResolvedPathItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResolvedPathItem

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

Formats the value using the given formatter.