Struct yy_boss::FilesystemPath

pub struct FilesystemPath {
    pub name: String,
    pub path: PathBuf,
}

Paths on the File System.

If a user joins path with a yyp's absolute folder location, the resulting path will always point to a valid file.

path will always point to a file, and the file it points to will always have a .yy extension. The name field and the file_name of the path will always be equal to each other.

Fields

name: String

The name of the resource which the Path points to. For an spr_sprite, for example, it will be spr_sprite.

path: PathBuf

The direct path from the .yyp directory to the resource needed on the file system.

Implementations

impl FilesystemPath

pub fn new(base: &str, name: &str) -> FilesystemPath

Constructs a new path out of a base and a name. This is just a convenience method.

Trait Implementations

impl Clone for FilesystemPath

fn clone(&self) -> FilesystemPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FilesystemPath

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

Formats the value using the given formatter.

impl Default for FilesystemPath

fn default() -> FilesystemPath

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for FilesystemPath

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

Deserialize this value from the given Serde deserializer.

impl Eq for FilesystemPath

impl Hash for FilesystemPath

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, 

Feeds a slice of this type into the given [Hasher].

impl Ord for FilesystemPath

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<FilesystemPath> for FilesystemPath

fn eq(&self, other: &FilesystemPath) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &FilesystemPath) -> bool

This method tests for !=.

impl PartialOrd<FilesystemPath> for FilesystemPath

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for FilesystemPath

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 YypSerialization for FilesystemPath

fn yyp_serialization(&self, _: usize) -> String

const LINE_ENDING: &'static str