Struct Global

pub(crate) struct Global {

    pub(crate) config: Config,
    pub(crate) database: Pool<AsyncPgConnection>,
    pub(crate) user_loader: DataLoader<UserLoader>,
    pub(crate) organization_loader: DataLoader<OrganizationLoader>,
    pub(crate) organization_member_by_user_id_loader: DataLoader<OrganizationMemberByUserIdLoader>,
    pub(crate) external_http_client: Client,
    pub(crate) webauthn: Webauthn,
    pub(crate) open_telemetry: OpenTelemetry,
    pub(crate) redis: Pool,
    pub(crate) email_service_client: EmailServiceClient<Channel>,
    pub(crate) geoip_resolver: GeoIpResolver,
    pub(crate) aws_ses_req_signer: Signer<Credential>,
    pub(crate) mtls_root_cert: Vec<u8>,
    pub(crate) mtls_core_cert: Vec<u8>,
    pub(crate) mtls_core_private_key: Vec<u8>,
    pub(crate) mtls_email_cert: Vec<u8>,
    pub(crate) mtls_email_private_key: Vec<u8>,
}

Fields

config: Config

database: Pool<AsyncPgConnection>

user_loader: DataLoader<UserLoader>

organization_loader: DataLoader<OrganizationLoader>

organization_member_by_user_id_loader: DataLoader<OrganizationMemberByUserIdLoader>

external_http_client: Client

webauthn: Webauthn

open_telemetry: OpenTelemetry

redis: Pool

email_service_client: EmailServiceClient<Channel>

geoip_resolver: GeoIpResolver

aws_ses_req_signer: Signer<Credential>

mtls_root_cert: Vec<u8>

mtls_core_cert: Vec<u8>

mtls_core_private_key: Vec<u8>

mtls_email_cert: Vec<u8>

mtls_email_private_key: Vec<u8>

Trait Implementations

impl AwsInterface for Global

fn aws_region(&self) -> &str

fn aws_ses_req_signer(&self) -> &Signer<Credential>

impl ConfigInterface for Global

fn dashboard_origin(&self) -> &Url

fn email_from_name(&self) -> &str

fn email_from_address(&self) -> &str

fn google_oauth2_config(&self) -> GoogleOAuth2Config<'_>

fn service_bind(&self) -> SocketAddr

fn swagger_ui_enabled(&self) -> bool

fn timeout_config(&self) -> TimeoutConfig

fn turnstile_secret_key(&self) -> &str

impl ConfigInterface for Global

fn service_bind(&self) -> SocketAddr

impl DatabaseInterface for Global

type Connection<'a> = PooledConnection<'a, AsyncDieselConnectionManager<AsyncPgConnection>> where Self: 'a

async fn db(&self) -> Result<Self::Connection<'_>>

impl DataloaderInterface for Global

fn organization_loader(&self) -> &DataLoader<OrganizationLoader>

fn user_loader(&self) -> &DataLoader<UserLoader>

fn organization_member_by_user_id_loader( &self, ) -> &DataLoader<OrganizationMemberByUserIdLoader>

impl EmailInterface for Global

fn email_service(&self) -> impl EmailServiceClient

impl GeoIpInterface for Global

fn geo_ip_resolver(&self) -> &GeoIpResolver

fn reverse_proxy_config(&self) -> Option<ReverseProxyConfig<'_>>

impl Global for Global

type Config = Config

The config type for the global.

async fn init(config: Self::Config) -> Result<Arc<Self>>

Initialize the global.

fn pre_init() -> Result<(), Error>

Pre-initialization.

fn tokio_runtime() -> Runtime

Builds the tokio runtime for the process.

fn on_services_start( self: &Arc<Self>, ) -> impl Future<Output = Result<(), Error>> + Send

Called right before all services start.

fn on_service_exit( self: &Arc<Self>, name: &'static str, result: Result<(), Error>, ) -> impl Future<Output = Result<(), Error>> + Send

Called after a service exits.

fn on_exit( self: &Arc<Self>, result: Result<(), Error>, ) -> impl Future<Output = Result<(), Error>> + Send

Called after the shutdown is complete, right before exiting the process.

impl HttpClientInterface for Global

fn external_http_client(&self) -> &Client

impl HttpClientInterface for Global

fn external_http_client(&self) -> &Client

impl MtlsInterface for Global

fn mtls_root_cert_pem(&self) -> &[u8]

fn mtls_cert_pem(&self) -> &[u8]

fn mtls_private_key_pem(&self) -> &[u8]

impl MtlsInterface for Global

fn mtls_root_cert_pem(&self) -> &[u8]

fn mtls_cert_pem(&self) -> &[u8]

fn mtls_private_key_pem(&self) -> &[u8]

impl RedisInterface for Global

type RedisConnection<'a> = Pool where Self: 'a

fn redis(&self) -> &Self::RedisConnection<'_>

impl SignalConfig for Global

fn signals(&self) -> Vec<SignalKind>

The signals to listen for.

fn timeout(&self) -> Option<Duration>

The timeout before forcing a shutdown.

fn on_shutdown( self: &Arc<Self>, ) -> impl Future<Output = Result<(), Error>> + Send

Called when the service is shutting down.

fn on_force_shutdown( &self, signal: Option<SignalKind>, ) -> impl Future<Output = Result<(), Error>> + Send

Called when the service is force shutting down.

fn block_global_shutdown(&self) -> impl Future<Output = ()> + Send

Waits for the global shutdown to complete after a signal cancels the local context. Defaults to the global context’s shutdown ([scuffle_context::Handler::global().shutdown()]). Override to use a custom context or condition for shutdown completion.

impl TelemetryConfig for Global

fn enabled(&self) -> bool

Return true if the service is enabled.

fn bind_address(&self) -> Option<SocketAddr>

Return the bind address for the http server.

fn http_server_name(&self) -> &str

Return the http server name.

fn opentelemetry(&self) -> Option<&OpenTelemetry>

Pass an OpenTelemetry instance to the service.

fn health_check(&self) -> impl Future<Output = Result<(), Error>> + Send

Return a health check to determine if the service is healthy.

fn prometheus_metrics_registry(&self) -> Option<&Registry>

Return a Prometheus metrics registry to scrape metrics from.

impl WebAuthnInterface for Global

fn webauthn(&self) -> &Webauthn

impl Global for Global

impl Global for Global