Skip to main content

GCHubRestServerBuilder

Struct GCHubRestServerBuilder 

pub struct GCHubRestServerBuilder {
Show 14 fields bind_addr: String, port: u16, internal_bind_addr: String, internal_port: u16, tls_cert_path: Option<PathBuf>, tls_key_path: Option<PathBuf>, config_db: GCSharedConfigDatabase, rt_manager: GCSharedRuntimeManager, serve_path: Option<PathBuf>, log_reader_connection: Option<LogReaderConnection>, ldap_config: Option<LdapConfigBuilder>, default_user: Option<UserID>, systemd_runner_enable: bool, timeseries_pool: Option<PgPool>,
}
Expand description

Builds and runs the internal and public HTTP(S) servers

Fields§

§bind_addr: String§port: u16§internal_bind_addr: String§internal_port: u16§tls_cert_path: Option<PathBuf>§tls_key_path: Option<PathBuf>§config_db: GCSharedConfigDatabase§rt_manager: GCSharedRuntimeManager§serve_path: Option<PathBuf>§log_reader_connection: Option<LogReaderConnection>§ldap_config: Option<LdapConfigBuilder>§default_user: Option<UserID>§systemd_runner_enable: bool§timeseries_pool: Option<PgPool>

Implementations§

§

impl GCHubRestServerBuilder

pub fn new( rt_manager: GCSharedRuntimeManager, config_db: GCSharedConfigDatabase, ) -> Self

pub fn set_port(self, port: u16) -> Self

pub fn set_bind_addr(self, bind_addr: &str) -> Self

pub fn set_internal_bind_addr(self, addr: &str) -> Self

Sets the bind address for the internal server (default: "127.0.0.1").

pub fn set_internal_port(self, port: u16) -> Self

Sets the port for the internal server (default: 3000).

pub fn set_tls(self, cert: PathBuf, key: PathBuf) -> Self

Configures TLS for the public server using explicit PEM certificate and key paths.

pub fn set_timeseries_pool(self, pool: PgPool) -> Self

pub fn set_serve_directory(self, path: PathBuf) -> Self

pub fn set_log_reader_connection(self, conn: LogReaderConnection) -> Self

pub fn set_systemd_runner_enable(self, enabled: bool) -> Self

pub fn set_disable_auth(self, user: UserID) -> Self

Disables authentication and authorization by injecting a fixed user for all routes.

pub fn set_ldap(self, ldap_auth: LdapConfigBuilder) -> Self

pub async fn run(self) -> Result<(), GCHubRestServerError>

Builds the routers, binds listeners, and runs both servers concurrently until one exits.

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
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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
§

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

§

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
§

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

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more