Struct yy_typings::ViewPath

pub struct ViewPath {
    pub name: String,
    pub path: ViewPathLocation,
}

Viewpaths in the virtual file system created by the Folders in the Yyp, deliminated by /, and with a ViewPathLocation which ends in .yy.\ or in .yyp.

Please note, the Default implementation in this type is never a valid option. It is provided for convenience, but the default Root for any file not in a folder is as follows:

let root_path = ViewPath {
    name: PROJECT_NAME.to_string(),
    path: ViewPathLocation(format!("{}.yyp", PROJECT_NAME))
};

Fields

name: String

The human readable name of the parent. for a spr_player, this might correspond to Sprites.

path: ViewPathLocation

The path to the view member itself.

Trait Implementations

impl Clone for ViewPath

fn clone(&self) -> ViewPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ViewPath

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

Formats the value using the given formatter.

impl Default for ViewPath

fn default() -> ViewPath

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for ViewPath

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

Deserialize this value from the given Serde deserializer.

impl Eq for ViewPath

impl Hash for ViewPath

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, 

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

impl Ord for ViewPath

fn cmp(&self, other: &ViewPath) -> 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<ViewPath> for ViewPath

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

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

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

This method tests for !=.

impl PartialOrd<ViewPath> for ViewPath

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

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

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

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

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

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

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

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

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

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

impl Serialize for ViewPath

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

Serialize this value into the given Serde serializer.

impl StructuralEq for ViewPath

impl StructuralPartialEq for ViewPath