Skip to main content

Container

Struct Container 

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

Application service container

Holds shared services initialized during application bootstrap. Services are wrapped in Arc<T> for thread-safe shared ownership across the application.

§Example

use std::path::Path;
use torrust_tracker_deployer_lib::bootstrap::container::Container;
use torrust_tracker_deployer_lib::presentation::cli::views::VerbosityLevel;

let working_dir = Path::new(".");
let container = Container::new(VerbosityLevel::Normal, working_dir);
let user_output = container.user_output();
user_output.lock().borrow_mut().success("Operation completed");

Implementations§

Source§

impl Container

Source

pub fn new(verbosity_level: VerbosityLevel, working_dir: &Path) -> Self

Create a new container with initialized services

Initializes all services with specified verbosity level and working directory:

  • UserOutput with provided verbosity_level
  • FileRepositoryFactory with DEFAULT_LOCK_TIMEOUT
  • EnvironmentRepository using working_dir/data as base directory
  • SystemClock for time operations
§Arguments
  • verbosity_level - Controls how verbose the user output will be
  • working_dir - Base working directory for the application (repository uses working_dir/data)
§Examples
use std::path::Path;
use torrust_tracker_deployer_lib::bootstrap::container::Container;
use torrust_tracker_deployer_lib::presentation::cli::views::VerbosityLevel;

// For normal application use
let container = Container::new(VerbosityLevel::Normal, Path::new("."));

// For completely silent testing
let container = Container::new(VerbosityLevel::Silent, Path::new("/tmp/test"));
Source

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

Get shared reference to user output service

Returns an Arc<ReentrantMutex<RefCell<UserOutput>>> that can be safely cloned and shared across threads and function calls. Use the reentrant lock to acquire access, then borrow_mut() to get mutable access to the user output. The reentrant mutex prevents deadlocks when the same thread needs to acquire the lock multiple times.

§Example
use std::path::Path;
use torrust_tracker_deployer_lib::bootstrap::container::Container;
use torrust_tracker_deployer_lib::presentation::cli::views::VerbosityLevel;

let container = Container::new(VerbosityLevel::Normal, Path::new("."));
let user_output = container.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 an Arc<FileRepositoryFactory> that can be cheaply cloned and shared across threads and function calls.

§Example
use std::path::Path;
use torrust_tracker_deployer_lib::bootstrap::container::Container;
use torrust_tracker_deployer_lib::presentation::cli::views::VerbosityLevel;

let container = Container::new(VerbosityLevel::Normal, Path::new("."));
let file_repository_factory = container.file_repository_factory();
// Use file_repository_factory to create repositories
Source

pub fn repository_provider(&self) -> Arc<dyn RepositoryProvider>

Get shared reference to repository provider

Returns an Arc<dyn RepositoryProvider> that can be passed to application-layer handlers without exposing the concrete infrastructure type.

Source

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

Get shared reference to environment repository

Returns an Arc<dyn EnvironmentRepository> that can be cheaply cloned and shared across threads and function calls. The repository is initialized with the application’s base data directory during container creation.

§Example
use std::path::Path;
use torrust_tracker_deployer_lib::bootstrap::container::Container;
use torrust_tracker_deployer_lib::presentation::cli::views::VerbosityLevel;

let container = Container::new(VerbosityLevel::Normal, Path::new("."));
let repository = container.repository();
// Use repository to load/save environment state
Source

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

Get shared reference to clock service

Returns an Arc<dyn Clock> that can be cheaply cloned and shared across threads and function calls.

§Example
use std::path::Path;
use torrust_tracker_deployer_lib::bootstrap::container::Container;
use torrust_tracker_deployer_lib::presentation::cli::views::VerbosityLevel;

let container = Container::new(VerbosityLevel::Normal, Path::new("."));
let clock = container.clock();
// Use clock for time operations
Source

pub fn create_environment_controller( &self, ) -> CreateEnvironmentCommandController

Create a new CreateEnvironmentCommandController

Source

pub fn create_template_controller(&self) -> CreateTemplateCommandController

Create a new CreateTemplateCommandController

Source

pub fn create_schema_controller(&self) -> CreateSchemaCommandController

Create a new CreateSchemaCommandController

Source

pub fn create_docs_controller(&self) -> DocsCommandController

Create a new DocsCommandController

Source

pub fn create_provision_controller(&self) -> ProvisionCommandController

Create a new ProvisionCommandController

Source

pub fn create_destroy_controller(&self) -> DestroyCommandController

Create a new DestroyCommandController

Source

pub fn create_purge_controller(&self) -> PurgeCommandController

Create a new PurgeCommandController

Source

pub fn create_configure_controller(&self) -> ConfigureCommandController

Create a new ConfigureCommandController

Source

pub fn create_test_controller(&self) -> TestCommandController

Create a new TestCommandController

Source

pub fn create_validate_controller(&self) -> ValidateCommandController

Create a new ValidateCommandController

Source

pub fn create_register_controller(&self) -> RegisterCommandController

Create a new RegisterCommandController

Source

pub fn create_release_controller(&self) -> ReleaseCommandController

Create a new ReleaseCommandController

Source

pub fn create_render_controller(&self) -> RenderCommandController

Create a new RenderCommandController

Source

pub fn create_run_controller(&self) -> RunCommandController

Create a new RunCommandController

Source

pub fn create_show_controller(&self) -> ShowCommandController

Create a new ShowCommandController

Source

pub fn create_exists_controller(&self) -> ExistsCommandController

Create a new ExistsCommandController

Source

pub fn create_list_controller(&self) -> ListCommandController

Create a new ListCommandController

Source

pub fn data_directory(&self) -> Arc<Path>

Get shared reference to data directory path

Returns an Arc<Path> pointing to the data directory where environment state files are stored.

Trait Implementations§

Source§

impl Clone for Container

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

impl Default for Container

Source§

fn default() -> Self

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