Struct ModulePath

pub struct ModulePath {
    pub origin: PathOrigin,
    pub components: Vec<String>,
}

Fields

origin: PathOrigin

components: Vec<String>

Implementations

impl ModulePath

pub fn new(origin: PathOrigin, components: Vec<String>) -> ModulePath

Create a new module path from components.

Precondition: the path components must be valid WGSL identifiers.

pub fn from_path(path: impl AsRef<Path>) -> ModulePath

Create a new module path from a filesystem path.

• Paths with a root (leading / on Unix) produce package:: paths.
• Relative paths (starting with . or ..) produce self:: or super:: paths.
• The file extension is ignored.
• The path is canonicalized and to do so it does NOT follow symlinks.

Precondition: the path components must be valid WGSL identifiers.

pub fn to_path_buf(&self) -> PathBuf

Create a PathBuf from a ModulePath.

• package:: paths are rooted (start with /).
• self::orsuper::are relative (starting with.or..).
• There is no file extension.

pub fn push(&mut self, item: &str)

Append a component to the path.

Precondition: the item must be a valid WGSL identifier.

pub fn first(&self) -> Option<&str>

Get the first component of the module path.

pub fn last(&self) -> Option<&str>

Get the last component of the module path.

pub fn join(self, suffix: impl IntoIterator<Item = String>) -> ModulePath

Append suffix to the module path.

pub fn join_path(&self, path: &ModulePath) -> Option<ModulePath>

Append suffix to the module path. the suffix must be a relative module path.

pub fn starts_with(&self, prefix: &ModulePath) -> bool

pub fn is_empty(&self) -> bool

Trait Implementations

impl Clone for ModulePath

fn clone(&self) -> ModulePath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModulePath

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

Formats the value using the given formatter.

impl Default for ModulePath

fn default() -> ModulePath

The path that is represented as ``, i.e. a package import with no components.

impl Display for ModulePath

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

Formats the value using the given formatter.

impl<T> From<T> for ModulePath

where T: AsRef<Path>,

fn from(value: T) -> ModulePath

Converts to this type from the input type.

impl Hash for ModulePath

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ModulePath

fn eq(&self, other: &ModulePath) -> 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 ModulePath

impl StructuralPartialEq for ModulePath