Skip to main content

HandlerContext

Struct HandlerContext 

Source
pub struct HandlerContext<'a> {
    pub command_name: &'a str,
    pub args: &'a [String],
    pub working_directory: &'a Path,
    pub remote: bool,
    pub receives_piped_input: bool,
    pub cd_allowed_dirs: &'a [PathBuf],
}
Expand description

Context passed to handlers for classification.

Fields§

§command_name: &'a str§args: &'a [String]§working_directory: &'a Path§remote: bool§receives_piped_input: bool§cd_allowed_dirs: &'a [PathBuf]

Extra directories that cd is allowed to navigate to (from config).

Implementations§

Source§

impl HandlerContext<'_>

Source

pub fn subcommand(&self) -> &str

Get the first argument (typically a subcommand).

Source

pub fn arg(&self, n: usize) -> &str

Get the Nth argument.

Source

pub fn read_file(&self, path: &str) -> Option<String>

Read a file’s contents for informed classification.

Returns None if the file can’t be read (remote mode, missing, too large, binary, or outside the working directory).

Auto Trait Implementations§

§

impl<'a> Freeze for HandlerContext<'a>

§

impl<'a> RefUnwindSafe for HandlerContext<'a>

§

impl<'a> Send for HandlerContext<'a>

§

impl<'a> Sync for HandlerContext<'a>

§

impl<'a> Unpin for HandlerContext<'a>

§

impl<'a> UnsafeUnpin for HandlerContext<'a>

§

impl<'a> UnwindSafe for HandlerContext<'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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> 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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.