Struct Directives 

pub struct Directives {
    pub enabled: bool,
}

Emits directives for the wrapper shell, or does nothing when the binary runs outside of it.

Directives go to stderr and are flushed immediately, so they are in place before any prompt that follows. Write errors are ignored: a closed stderr leaves the player’s shell unchanged, which is the only sensible outcome.

Fields

enabled: bool

true when SHELLGAME_WRAPPER is set, i.e. a shell function will replay the output.

Implementations

impl Directives

pub fn new(enabled: bool) -> Self

Creates an emitter. Pass false outside the wrapper: nobody would replay the lines and they would be printed to the player as noise.

pub fn cd(&self, path: impl AsRef<Path>)

Asks the shell to change its working directory to path.

The shell moves with the plain cd implementation, never through the player-facing hook, so teleports are exempt from level restrictions.

pub fn export( &self, name: &str, value: impl AsRef<OsStr>, ) -> Result<(), InvalidName>

Asks the shell to set and export name=value. The value may be any string or path; its raw bytes are sent.

Errors

Returns InvalidName (and emits nothing) unless name matches ^[A-Za-z_][A-Za-z0-9_]*$. The name is checked even when directives are disabled, so a mistake surfaces in tests that run outside the wrapper.

pub fn echo(&self, message: impl AsRef<str>)

Asks the shell to print message followed by a newline.

pub fn pwd(&self)

Asks the shell to print its working directory.

pub fn exit(&self)

Asks the shell to close the game shell, for example after the game data was removed.

Trait Implementations

impl Clone for Directives

fn clone(&self) -> Directives

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Directives

impl Debug for Directives

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

Formats the value using the given formatter.

impl Default for Directives

fn default() -> Directives

Returns the “default value” for a type.

impl Eq for Directives

impl PartialEq for Directives

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Directives