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 new_root() -> ModulePath

Create a module path that refers to the root module, i.e. package.

Technically import package; is not a valid import statement in WESL code. However adding an item to the path, such as import package::foo; points at declaration foo in the root module.

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.

Preconditions:

• The path must not start with a prefix, like C:\ on windows.
• The path must contain at least one named component.
• Named components must be valid module names. (Module names are WGSL identifiers + certain reserved names, see wesl-spec#127)

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, suffix: &ModulePath) -> ModulePath

Append suffix to the module path.

This function produces a ModulePath relative to self, as if suffix was imported from module self.

• If suffix is relative, it appends its components to self.
• If suffix if absolute or package, it ignores self components.
• If both self and suffix are package paths, then suffix imports from a sub-package. The package is renamed with a slash separating package names. (TODO: this is a hack)

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

Whether the module path starts with a prefix.

pub fn is_root(&self) -> bool

Whether the module path points at the route module.

See Self::new_root.

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<'de> Deserialize<'de> for ModulePath

fn deserialize<__D>( __deserializer: __D, ) -> Result<ModulePath, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ModulePath

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

Formats the value using the given formatter.

impl FromStr for ModulePath

fn from_str(s: &str) -> Result<ModulePath, <ModulePath as FromStr>::Err>

Parse a WGSL string into a module path.

Preconditions:

• The path components must be valid WESL module names.

type Err = ModulePathParseError

The associated error which can be returned from parsing.

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 Serialize for ModulePath

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ModulePath

impl StructuralPartialEq for ModulePath