Skip to main content

ExecutionContext

Struct ExecutionContext 

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

§Design Consideration: Shared State Access

Currently, there is no shared mutable state in the system that requires Arc<Mutex<T>> patterns. However, if shared state is needed in the future, it can be added to the Container and accessed through standard Rust concurrency patterns:

§Examples

use std::sync::Arc;
use std::path::Path;
use torrust_tracker_deployer_lib::bootstrap::Container;
use torrust_tracker_deployer_lib::presentation::cli::views::VerbosityLevel;
use torrust_tracker_deployer_lib::presentation::cli::dispatch::ExecutionContext;

let container = Arc::new(Container::new(VerbosityLevel::Normal, Path::new(".")));
let context = ExecutionContext::new(container, global_args);

// Access user output service
let user_output = context.user_output();
user_output.lock().borrow_mut().success("Operation completed");

Implementations§

Source§

impl ExecutionContext

Source

pub fn new(container: Arc<Container>, global_args: GlobalArgs) -> Self

Create a new execution context from a container

§Arguments
  • container - Application service container with initialized services
  • global_args - Global CLI arguments (logging config, output format, etc.)
§Examples
use torrust_tracker_deployer_lib::bootstrap::Container;
use torrust_tracker_deployer_lib::presentation::cli::views::VerbosityLevel;
use torrust_tracker_deployer_lib::presentation::cli::dispatch::ExecutionContext;
use torrust_tracker_deployer_lib::presentation::cli::input::cli::args::GlobalArgs;
use torrust_tracker_deployer_lib::bootstrap::logging::{LogFormat, LogOutput};
use torrust_tracker_deployer_lib::presentation::cli::input::cli::OutputFormat;
use std::sync::Arc;
use std::path::PathBuf;

let container = Container::new(VerbosityLevel::Normal, &PathBuf::from("."));
let global_args = GlobalArgs {
    log_file_format: LogFormat::Compact,
    log_stderr_format: LogFormat::Pretty,
    log_output: LogOutput::FileOnly,
    log_dir: PathBuf::from("./data/logs"),
    working_dir: PathBuf::from("."),
    output_format: OutputFormat::Text,
    verbosity: 0,
};
let context = ExecutionContext::new(Arc::new(container), global_args);
Source

pub fn container(&self) -> &Arc<Container>

Get reference to the underlying container

Provides access to the raw container for cases where direct access to container methods is needed.

§Examples
use std::path::Path;
use torrust_tracker_deployer_lib::bootstrap::Container;
use torrust_tracker_deployer_lib::presentation::cli::views::VerbosityLevel;
use torrust_tracker_deployer_lib::presentation::cli::dispatch::ExecutionContext;
use std::sync::Arc;

let container = Container::new(VerbosityLevel::Normal, Path::new("."));
let context = ExecutionContext::new(Arc::new(container), global_args);

let container_ref = context.container();
// Use container_ref as needed
Source

pub fn user_output(&self) -> Arc<ReentrantMutex<RefCell<UserOutput>>>

Get shared reference to user output service

Returns the user output service for displaying messages, progress, and results to users. The service is wrapped in Arc<Mutex<T>> for thread-safe shared access.

§Examples
use torrust_tracker_deployer_lib::bootstrap::Container;
use torrust_tracker_deployer_lib::presentation::cli::views::VerbosityLevel;
use torrust_tracker_deployer_lib::presentation::cli::dispatch::ExecutionContext;
use std::sync::Arc;
use std::path::Path;

let container = Container::new(VerbosityLevel::Normal, Path::new("."));
let context = ExecutionContext::new(Arc::new(container), global_args);

let user_output = context.user_output();
user_output.lock().borrow_mut().success("Operation completed");
Source

pub fn file_repository_factory(&self) -> Arc<FileRepositoryFactory>

Get shared reference to repository factory service

Returns the repository factory service for creating environment repositories. The service is wrapped in Arc<T> for shared access.

§Examples
use torrust_tracker_deployer_lib::bootstrap::Container;
use torrust_tracker_deployer_lib::presentation::cli::views::VerbosityLevel;
use torrust_tracker_deployer_lib::presentation::cli::dispatch::ExecutionContext;
use std::sync::Arc;
use std::path::Path;

let container = Container::new(VerbosityLevel::Normal, Path::new("."));
let context = ExecutionContext::new(Arc::new(container), global_args);

let file_repository_factory = context.file_repository_factory();
// Use file_repository_factory to create repositories
Source

pub fn repository(&self) -> Arc<dyn EnvironmentRepository + Send + Sync>

Get shared reference to environment repository

Returns the environment repository for persistence operations. The repository is wrapped in Arc<dyn EnvironmentRepository> for shared access.

§Examples
use torrust_tracker_deployer_lib::bootstrap::Container;
use torrust_tracker_deployer_lib::presentation::cli::views::VerbosityLevel;
use torrust_tracker_deployer_lib::presentation::cli::dispatch::ExecutionContext;
use std::sync::Arc;
use std::path::Path;

let container = Container::new(VerbosityLevel::Normal, Path::new("."));
let context = ExecutionContext::new(Arc::new(container), global_args);

let repository = context.repository();
// Use repository for environment persistence
Source

pub fn clock(&self) -> Arc<dyn Clock>

Get shared reference to clock service

Returns the clock service for time-related operations. The service is wrapped in Arc<dyn Clock> for shared access.

§Examples
use torrust_tracker_deployer_lib::bootstrap::Container;
use torrust_tracker_deployer_lib::presentation::cli::views::VerbosityLevel;
use torrust_tracker_deployer_lib::presentation::cli::dispatch::ExecutionContext;
use std::sync::Arc;
use std::path::Path;

let container = Container::new(VerbosityLevel::Normal, Path::new("."));
let context = ExecutionContext::new(Arc::new(container), global_args);

let clock = context.clock();
// Use clock for time operations
Source

pub fn output_format(&self) -> OutputFormat

Get the output format from global CLI arguments

Returns the user-specified output format (Text or Json) for command results. This allows controllers to format their output appropriately based on user preference.

§Examples
use torrust_tracker_deployer_lib::bootstrap::Container;
use torrust_tracker_deployer_lib::presentation::cli::views::VerbosityLevel;
use torrust_tracker_deployer_lib::presentation::cli::dispatch::ExecutionContext;
use torrust_tracker_deployer_lib::presentation::cli::input::cli::args::GlobalArgs;
use torrust_tracker_deployer_lib::presentation::cli::input::cli::OutputFormat;
use torrust_tracker_deployer_lib::bootstrap::logging::{LogFormat, LogOutput};
use std::sync::Arc;
use std::path::PathBuf;

let container = Container::new(VerbosityLevel::Normal, &PathBuf::from("."));
let global_args = GlobalArgs {
    log_file_format: LogFormat::Compact,
    log_stderr_format: LogFormat::Pretty,
    log_output: LogOutput::FileOnly,
    log_dir: PathBuf::from("./data/logs"),
    working_dir: PathBuf::from("."),
    output_format: OutputFormat::Json,
    verbosity: 0,
};
let context = ExecutionContext::new(Arc::new(container), global_args);

let format = context.output_format();
match format {
    OutputFormat::Text => println!("Human-readable text"),
    OutputFormat::Json => println!("{{\"result\": \"json\"}}"),
}
Source

pub fn working_dir(&self) -> &Path

Get the working directory from global CLI arguments

Returns the working directory path specified by the user (or default “.”). This is where environment data will be stored (data/ and build/ subdirectories).

§Examples
use torrust_tracker_deployer_lib::bootstrap::Container;
use torrust_tracker_deployer_lib::presentation::cli::views::VerbosityLevel;
use torrust_tracker_deployer_lib::presentation::cli::dispatch::ExecutionContext;
use torrust_tracker_deployer_lib::presentation::cli::input::cli::args::GlobalArgs;
use torrust_tracker_deployer_lib::presentation::cli::input::cli::OutputFormat;
use torrust_tracker_deployer_lib::bootstrap::logging::{LogFormat, LogOutput};
use std::sync::Arc;
use std::path::PathBuf;

let container = Container::new(VerbosityLevel::Normal, &PathBuf::from("."));
let global_args = GlobalArgs {
    log_file_format: LogFormat::Compact,
    log_stderr_format: LogFormat::Pretty,
    log_output: LogOutput::FileOnly,
    log_dir: PathBuf::from("./data/logs"),
    working_dir: PathBuf::from("/tmp/test-workspace"),
    output_format: OutputFormat::Text,
    verbosity: 0,
};
let context = ExecutionContext::new(Arc::new(container), global_args);

let working_dir = context.working_dir();
println!("Working directory: {}", working_dir.display());

Trait Implementations§

Source§

impl Clone for ExecutionContext

Source§

fn clone(&self) -> Self

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

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> 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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> IntoResult<T> for T

Source§

type Err = !

Source§

fn into_result(self) -> Result<T, <T as IntoResult<T>>::Err>

Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
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: 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> 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 = !

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<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