Skip to main content

Ctx

Struct Ctx 

Source
pub struct Ctx<'a> {
    pub workspace: &'a Path,
    pub section_root: PathBuf,
    pub cwd: Option<PathBuf>,
    pub home: &'a Path,
    pub level: LevelId,
}
Expand description

The facts about the player’s situation that requirements, answers and cd rules consult.

The engine never reads the process working directory, HOME or any environment variable: the caller captures them once and hands them in here. That keeps every rule a plain function of its inputs, so tests run in parallel without chdir or set_var.

Fields§

§workspace: &'a Path

The workspace root (holds level-N directories and the marker files).

§section_root: PathBuf

The absolute directory every path of the current level is relative to.

§cwd: Option<PathBuf>

The player’s current directory, already canonical, or None when it no longer exists (the player deleted the directory they were standing in).

§home: &'a Path

The logical $HOME.

§level: LevelId

The level being checked.

Implementations§

Source§

impl<'a> Ctx<'a>

Source

pub fn new( workspace: &'a Path, section_root: PathBuf, cwd: Option<PathBuf>, home: &'a Path, level: LevelId, ) -> Self

Gather the facts. See the field docs for what each one must be.

Source

pub fn markers(&self) -> Markers<'a>

The marker files of the current level.

Source

pub fn home_name(&self) -> String

The last component of $HOME, such as ada for /home/ada (empty for /).

Source

pub fn path(&self, rel: &str) -> Result<PathBuf, ContainmentError>

Resolve a section-relative path with the full containment rules: no absolute paths, no .., no symlinked component.

Trait Implementations§

Source§

impl<'a> Clone for Ctx<'a>

Source§

fn clone(&self) -> Ctx<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for Ctx<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for Ctx<'a>

§

impl<'a> RefUnwindSafe for Ctx<'a>

§

impl<'a> Send for Ctx<'a>

§

impl<'a> Sync for Ctx<'a>

§

impl<'a> Unpin for Ctx<'a>

§

impl<'a> UnsafeUnpin for Ctx<'a>

§

impl<'a> UnwindSafe for Ctx<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.