OperationContext

Struct OperationContext 

Source
pub struct OperationContext { /* private fields */ }
Expand description

Context for a single CLI operation (install, update, validate, etc.)

This context object flows through the operation call chain, providing operation-scoped state like warning deduplication. It uses Mutex for interior mutability to support async operations that may span multiple threads.

§Thread Safety

This struct is thread-safe and can be shared across async .await points. Uses Mutex for interior mutability, which has minimal overhead since contention is unlikely (warnings are infrequent).

§Lifecycle

  1. Created at the start of a CLI command (InstallCommand::execute(), etc.)
  2. Passed down through resolver → extractor → parser call chain
  3. Automatically cleaned up when the operation completes

§Examples

use agpm_cli::core::OperationContext;
use std::path::Path;

// Create context at operation start
let ctx = OperationContext::new();

// Use for warning deduplication
if ctx.should_warn_file(Path::new("invalid.md")) {
    eprintln!("Warning: Invalid file");
}

// Same file won't warn again
assert!(!ctx.should_warn_file(Path::new("invalid.md")));

Implementations§

Source§

impl OperationContext

Source

pub fn new() -> Self

Create a new operation context.

Call this at the start of each CLI operation that needs state tracking.

§Examples
use agpm_cli::core::OperationContext;

let ctx = OperationContext::new();
Source

pub fn should_warn_file(&self, path: &Path) -> bool

Check if we should warn about a file and mark it as warned.

Returns true if this is the first warning for this file in this operation, false if we’ve already warned about it (deduplicated).

§Deduplication Strategy

Uses filename-based keys (not full paths) to handle different path representations consistently:

  • /foo/bar/test.md and ./bar/test.md both key on "test.md"
  • This works across worktrees, relative paths, and symlinks
§Arguments
  • path - Path to the file being processed
§Returns
  • true - First warning for this file, caller should display the warning
  • false - Already warned about this file, caller should skip the warning
§Examples
use agpm_cli::core::OperationContext;
use std::path::Path;

let ctx = OperationContext::new();
let path = Path::new("agents/invalid.md");

// First call returns true
assert!(ctx.should_warn_file(path));

// Second call returns false (deduplicated)
assert!(!ctx.should_warn_file(path));
Source

pub fn warning_count(&self) -> usize

Get the count of unique files that have been warned about.

Useful for diagnostics and testing.

§Examples
use agpm_cli::core::OperationContext;
use std::path::Path;

let ctx = OperationContext::new();

assert_eq!(ctx.warning_count(), 0);

ctx.should_warn_file(Path::new("file1.md"));
ctx.should_warn_file(Path::new("file2.md"));

assert_eq!(ctx.warning_count(), 2);

Trait Implementations§

Source§

impl Debug for OperationContext

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for OperationContext

Source§

fn default() -> OperationContext

Returns the “default value” for a type. Read more

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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 = 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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