Struct AssetPath 

pub struct AssetPath { /* private fields */ }

A path to an asset, optionally qualified with a sub-asset label.

The syntax is "path/to/file.ext" or "path/to/file.ext#label".

Sub-asset labels allow a single file to expose multiple logical assets. For example a GLTF file can expose "scene.gltf#mesh0", "scene.gltf#mesh1".

Example

use proof_engine::asset::AssetPath;

let p = AssetPath::parse("models/robot.gltf#body_mesh");
assert_eq!(p.path().to_str().unwrap(), "models/robot.gltf");
assert_eq!(p.label(), Some("body_mesh"));

Implementations

impl AssetPath

pub fn new<P: AsRef<Path>>(path: P) -> Self

Create a new path with no sub-asset label.

pub fn with_label<P: AsRef<Path>>(path: P, label: impl Into<String>) -> Self

Create a path with an explicit sub-asset label.

pub fn parse(s: &str) -> Self

Parse a combined "path#label" string.

If no # is present the label is None.

pub fn path(&self) -> &Path

The file-system component of the path.

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

The optional sub-asset label.

pub fn extension(&self) -> Option<String>

File extension of the path (without the dot), lowercased.

pub fn to_string_repr(&self) -> String

Returns the canonical string representation "path" or "path#label".

Trait Implementations

impl Clone for AssetPath

fn clone(&self) -> AssetPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AssetPath

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

Formats the value using the given formatter.

impl Display for AssetPath

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

Formats the value using the given formatter.

impl From<&str> for AssetPath

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for AssetPath

fn from(s: String) -> Self

Converts to this type from the input type.

impl Hash for AssetPath

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

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 AssetPath

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

impl StructuralPartialEq for AssetPath