pub struct APIBuilder { /* private fields */ }Expand description
An API builder.
APIBuilder provides a simple and ergonomic builder pattern for constructing an API server from multiple handlers.
This allows composing portions of an API from individual building blocks.
§Missing
- TLS support
- API-wide authentication support (can be added at the per-handler level)
- graceful shutdown (shutdown stops new connections, but does not wait for existing connections to close)
Implementations§
Source§impl APIBuilder
impl APIBuilder
Sourcepub fn new() -> Self
pub fn new() -> Self
Create a new APIBuilder with an empty router.
A fallback route will be provided that returns a 404 Not Found response for any route that isn’t explicitly handled.
Sourcepub fn with_handler<H>(self, handler: H) -> Selfwhere
H: APIHandler,
pub fn with_handler<H>(self, handler: H) -> Selfwhere
H: APIHandler,
Adds the given handler to this builder.
The initial state and routes provided by the handler will be merged into this builder.
Sourcepub fn with_optional_handler<H>(self, handler: Option<H>) -> Selfwhere
H: APIHandler,
pub fn with_optional_handler<H>(self, handler: Option<H>) -> Selfwhere
H: APIHandler,
Adds the given optional handler to this builder.
If the handler is Some, the initial state and routes provided by the handler will be merged into this builder.
Otherwise, this builder will be returned unchanged.
Sourcepub fn with_grpc_service<S>(self, svc: S) -> Self
pub fn with_grpc_service<S>(self, svc: S) -> Self
Add the given gRPC service to this builder.
Sourcepub fn with_tls_config(self, config: ServerConfig) -> Self
pub fn with_tls_config(self, config: ServerConfig) -> Self
Sets the TLS configuration for the server.
This will enable TLS for the server, and the server will only accept connections that are encrypted with TLS.
Defaults to TLS being disabled.
Sourcepub fn with_self_signed_tls(self) -> Self
pub fn with_self_signed_tls(self) -> Self
Sets the TLS configuration for the server based on a dynamically generated self-signed certificate.
This will enable TLS for the server, and the server will only accept connections that are encrypted with TLS.
Sourcepub async fn serve<F>(
self,
listen_address: ListenAddress,
shutdown: F,
) -> Result<(), GenericError>
pub async fn serve<F>( self, listen_address: ListenAddress, shutdown: F, ) -> Result<(), GenericError>
Serves the API on the given listen address until shutdown resolves.
The listen address must be a connection-oriented address (TCP or Unix domain socket in SOCK_STREAM mode).
§Errors
If the given listen address is not connection-oriented, or if the server fails to bind to the address, or if there is an error while accepting for new connections, an error will be returned.
Trait Implementations§
Source§impl Default for APIBuilder
impl Default for APIBuilder
Source§fn default() -> APIBuilder
fn default() -> APIBuilder
Auto Trait Implementations§
impl Freeze for APIBuilder
impl !RefUnwindSafe for APIBuilder
impl Send for APIBuilder
impl Sync for APIBuilder
impl Unpin for APIBuilder
impl !UnwindSafe for APIBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T in a tonic::RequestSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> Track for T
impl<T> Track for T
Source§fn track_allocations(self, token: AllocationGroupToken) -> Tracked<Self>
fn track_allocations(self, token: AllocationGroupToken) -> Tracked<Self>
Tracked wrapper. Read moreSource§fn in_current_allocation_group(self) -> Tracked<Self>
fn in_current_allocation_group(self) -> Tracked<Self>
Tracked wrapper. Read more