Skip to main content

ServiceEndpoint

Struct ServiceEndpoint 

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

Represents a service endpoint for external validation testing

Internally stores a validated URL and the server IP address. For HTTPS endpoints, the IP is used to resolve the domain locally (since we can’t rely on DNS for .local domains).

§Examples

use std::net::SocketAddr;
use torrust_tracker_deployer_types::ServiceEndpoint;

// HTTP endpoint
let socket_addr: SocketAddr = "10.0.0.1:1212".parse().unwrap();
let endpoint = ServiceEndpoint::http(socket_addr, "/api/health_check").unwrap();
assert_eq!(endpoint.url().as_str(), "http://10.0.0.1:1212/api/health_check");

Implementations§

Source§

impl ServiceEndpoint

Source

pub fn http( socket_addr: SocketAddr, path: impl Into<String>, ) -> Result<ServiceEndpoint, InvalidServiceEndpointUrl>

Create a new HTTP endpoint (no TLS)

§Arguments
  • socket_addr - The IP address and port the service listens on
  • path - The health check path (e.g., /api/health_check)
§Errors

Returns an error if the socket address and path don’t form a valid URL.

Source

pub fn https( domain: &DomainName, path: impl Into<String>, server_ip: IpAddr, ) -> Result<ServiceEndpoint, InvalidServiceEndpointUrl>

Create a new HTTPS endpoint with TLS

§Arguments
  • domain - The domain name for HTTPS access (required for certificate issuance)
  • path - The health check path (e.g., /api/health_check)
  • server_ip - The IP address to resolve the domain to
§Errors

Returns an error if the domain and path don’t form a valid URL.

Source

pub fn url(&self) -> &Url

Returns the URL for this endpoint

Source

pub fn uses_tls(&self) -> bool

Returns true if this endpoint uses TLS (HTTPS)

Source

pub fn server_ip(&self) -> IpAddr

Returns the server IP address

Source

pub fn port(&self) -> u16

Returns the port for this endpoint

For HTTP: the configured port from the URL. For HTTPS: 443 (the default HTTPS port).

Source

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

Get the domain if this is an HTTPS endpoint

Source

pub fn is_local_domain(&self) -> bool

Check if the domain ends with .local (for self-signed cert handling)

Source

pub fn socket_addr(&self) -> SocketAddr

Returns the socket address for connecting to this endpoint

Combines the server IP with the port from the URL.

Trait Implementations§

Source§

impl Clone for ServiceEndpoint

Source§

fn clone(&self) -> ServiceEndpoint

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ServiceEndpoint

Source§

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

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

impl PartialEq for ServiceEndpoint

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for ServiceEndpoint

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§

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