Skip to main content

HttpTrackerConfig

Struct HttpTrackerConfig 

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

HTTP tracker bind configuration with domain invariants enforced at construction

This type guarantees that any instance is valid according to domain rules:

  • Bind address has a non-zero port
  • If TLS proxy is enabled, a domain is configured
  • If TLS proxy is enabled, bind address is not localhost

§Construction

Use HttpTrackerConfig::new() to create instances with validation:

use torrust_tracker_deployer_lib::domain::tracker::HttpTrackerConfig;
use torrust_tracker_deployer_lib::shared::DomainName;

// Without TLS
let config = HttpTrackerConfig::new(
    "0.0.0.0:7070".parse().unwrap(),
    None,
    false,
)?;

// With TLS (requires domain)
let tls_config = HttpTrackerConfig::new(
    "0.0.0.0:7070".parse().unwrap(),
    Some(DomainName::new("tracker.example.com")?),
    true,
)?;

§Invariants

The following invariants are enforced at construction time:

  1. No dynamic ports: bind_address.port() != 0
  2. TLS requires domain: use_tls_proxy == true implies domain.is_some()
  3. No localhost with TLS: use_tls_proxy == true implies !is_localhost(bind_address)

Implementations§

Source§

impl HttpTrackerConfig

Source

pub fn new( bind_address: SocketAddr, domain: Option<DomainName>, use_tls_proxy: bool, ) -> Result<Self, HttpTrackerConfigError>

Creates a new HTTP tracker configuration with validation

This is the primary way to construct an HttpTrackerConfig. All domain invariants are validated before the instance is created.

§Arguments
  • bind_address - Socket address to bind to (e.g., “0.0.0.0:7070”)
  • domain - Optional domain for TLS certificate (required if use_tls_proxy is true)
  • use_tls_proxy - Whether to enable TLS via Caddy reverse proxy
§Errors

Returns HttpTrackerConfigError if any invariant is violated:

  • DynamicPortNotSupported - if port is 0
  • TlsProxyRequiresDomain - if use_tls_proxy is true but domain is None
  • LocalhostWithTls - if use_tls_proxy is true and bind_address is localhost
§Examples
use torrust_tracker_deployer_lib::domain::tracker::HttpTrackerConfig;
use torrust_tracker_deployer_lib::shared::DomainName;

// Basic configuration without TLS
let config = HttpTrackerConfig::new(
    "0.0.0.0:7070".parse().unwrap(),
    None,
    false,
)?;

// Configuration with TLS (requires domain)
let tls_config = HttpTrackerConfig::new(
    "0.0.0.0:7070".parse().unwrap(),
    Some(DomainName::new("tracker.example.com")?),
    true,
)?;
Source

pub fn bind_address(&self) -> SocketAddr

Returns the bind address

Source

pub fn domain(&self) -> Option<&DomainName>

Returns a reference to the domain, if configured

Source

pub fn use_tls_proxy(&self) -> bool

Returns whether TLS proxy is enabled

Source

pub fn uses_tls_proxy(&self) -> bool

Returns true if this tracker uses the TLS proxy

Alias for use_tls_proxy() for semantic clarity.

Source

pub fn tls_domain(&self) -> Option<&DomainName>

Returns the domain name if TLS proxy is enabled

Returns None if TLS is disabled, even if a domain is configured. This is useful for determining the effective TLS domain.

Trait Implementations§

Source§

impl Clone for HttpTrackerConfig

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 Debug for HttpTrackerConfig

Source§

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

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

impl<'de> Deserialize<'de> for HttpTrackerConfig

Enables deserialization with validation through the constructor

This ensures that JSON deserialization also validates the config, maintaining the “always valid” invariant even for loaded data.

Source§

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for HttpTrackerConfig

Source§

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

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

impl PartialEq for HttpTrackerConfig

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for HttpTrackerConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for HttpTrackerConfig

Source§

impl TryFrom<HttpTrackerSection> for HttpTrackerConfig

Converts from application DTO to domain type using TryFrom trait

This implementation follows the standard library convention for fallible conversions, enabling use of .try_into() and TryFrom::try_from().

§Example

let section = HttpTrackerSection {
    bind_address: "0.0.0.0:7070".to_string(),
    domain: None,
    use_tls_proxy: None,
};
let config: HttpTrackerConfig = section.try_into()?;
Source§

type Error = CreateConfigError

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

fn try_from(section: HttpTrackerSection) -> Result<Self, Self::Error>

Performs the conversion.

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T> ToStringFallible for T
where T: Display,

Source§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

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