Struct Scope 

pub struct Scope { /* private fields */ }

Scope stores critical information regarding the applications current position within the filesystem. The context is considered to be the current working directory of the application while the workdir is used to point to the directory where all of the assets are stored.

Implementations

impl Scope

pub fn from_workdir<T>(workdir: T) -> Self

where T: ToString,

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

returns a reference to the context of the scope

pub fn context_mut(&mut self) -> Option<&mut String>

returns a mutable reference to the context of the scope

pub fn workdir(&self) -> &str

returns a reference to the workdir

pub fn as_path(&self) -> PathBuf

convert the scope into a PathBuf, automatically including the context if it exists

pub fn as_path_str(&self) -> String

converts the scope into a string

pub fn contextless(self) -> Self

consumes the current instance to ensure no context is present

pub fn set_cwd(&self)

sets the current working directory to the scope

pub fn set_context<T>(&mut self, context: T)

where T: ToString,

sets the context of the scope

pub fn set_workdir<T>(&mut self, workdir: T)

where T: ToString,

update the current workind directory

pub fn display(&self) -> String

returns a string representation of the scope

Trait Implementations

impl Clone for Scope

fn clone(&self) -> Scope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Scope

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

Formats the value using the given formatter.

impl Default for Scope

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Scope

where Scope: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Scope

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

Formats the value using the given formatter.

impl FromStr for Scope

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Scope

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 Ord for Scope

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Scope

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Scope

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Scope

impl StructuralPartialEq for Scope