Skip to main content

LokiGuard

Struct LokiGuard 

Source
pub struct LokiGuard { /* private fields */ }

Implementations§

Source§

impl LokiGuard

Source

pub fn new(root: impl Into<PathBuf>, mode: LokiMode) -> Self

root: the repository (or working directory) Loki checks; mode is on or advise.

Source

pub fn with_hygiene(self, level: Level) -> Self

Hygiene advisories for the lines a cell added, after a post-write check that found nothing to fix.

Source

pub fn with_timeout(self, timeout: Option<Duration>) -> Self

The limit on each before-write and before-shell check (see loki_timeout); None: no limit.

Source

pub fn with_post_write(self, post_write: bool) -> Self

Whether the files each cell changed are checked after it (postWrite; default on). Outside a Git repository only before-write checks run.

Source

pub fn with_project_python(self, python: Option<String>) -> Self

Post-write checks ask python (the project’s interpreter, findProjectPython; loki.ts passes it to the engine as LOKI_PYTHON) whether newly imported modules exist.

Source

pub fn with_hook(self, hook: HookRunner) -> Self

The same guard with another post-write engine (tests: a stand-in that answers scripted reports).

Trait Implementations§

Source§

impl FileWriteGuard for LokiGuard

Source§

fn timeout(&self) -> Option<Duration>

ULTRON_LOKI_TIMEOUT_MS when set (see loki_timeout); otherwise the in-process engine has no per-call limit (its tool runs have their own).

Source§

fn after_cell_changes( &self, changes: &CellChanges, _cwd: &Path, _lane: &str, ) -> Result<Option<AfterCellReport>, String>

afterCellChanges: hook on the files a cell changed inside the repository (at most 40).

Source§

fn name(&self) -> &str

Shown in notes and statistics (“Loki”).
Source§

fn before_write( &self, path: &Path, content: &str, _cwd: &Path, _lane: &str, ) -> Result<Verdict, String>

A proposed write of the cell on lane: the absolute, normalized path and the complete new text; cwd is the lane’s directory.
Source§

fn watches_cells(&self) -> bool

Whether the guard wants the files each cell changed (snapshots are taken only while one does); checked per cell.
Source§

fn before_shell(&self, command: &str, cwd: &Path) -> Result<Verdict, String>

A shell command that may write files (may_write_files), before it runs in cwd.
Source§

fn enabled(&self) -> bool

False while the guard has nothing to do (checked per call; file-hooks.ts enabled).
Source§

fn checks_writes(&self) -> bool

Whether the guard checks proposed writes / shell commands at all (TS: whether beforeWrite / beforeShell is defined); only those calls are counted in its statistics.
Source§

fn checks_shell(&self) -> bool

Source§

fn after_timeout(&self) -> Duration

How long after_cell_changes may take (default 120 s).

Auto Trait Implementations§

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more