Struct trillium_logger::Logger
source · pub struct Logger<F> { /* private fields */ }
Expand description
The trillium handler for this crate, and the core type
Implementations§
source§impl Logger<()>
impl Logger<()>
sourcepub fn new() -> Logger<impl LogFormatter>
pub fn new() -> Logger<impl LogFormatter>
Builds a new logger
Defaults:
- formatter:
dev_formatter
- color mode:
ColorMode::Auto
- target:
Target::Stdout
source§impl<T> Logger<T>
impl<T> Logger<T>
sourcepub fn with_formatter<Formatter: LogFormatter>(
self,
formatter: Formatter,
) -> Logger<Formatter>
pub fn with_formatter<Formatter: LogFormatter>( self, formatter: Formatter, ) -> Logger<Formatter>
replace the formatter with any type that implements LogFormatter
see the trait documentation for LogFormatter
for more details. note that this can be chained
with Logger::with_target
and Logger::with_color_mode
use trillium_logger::{Logger, apache_common};
Logger::new().with_formatter(apache_common("-", "-"));
source§impl<F: LogFormatter> Logger<F>
impl<F: LogFormatter> Logger<F>
sourcepub fn with_color_mode(self, color_mode: ColorMode) -> Self
pub fn with_color_mode(self, color_mode: ColorMode) -> Self
specify the color mode for this logger.
see ColorMode
for more details. note that this can be chained
with Logger::with_target
and Logger::with_formatter
use trillium_logger::{Logger, ColorMode};
Logger::new().with_color_mode(ColorMode::On);
sourcepub fn with_target(self, target: impl Targetable) -> Self
pub fn with_target(self, target: impl Targetable) -> Self
specify the logger target
see Target
for more details. note that this can be chained
with Logger::with_color_mode
and Logger::with_formatter
use trillium_logger::{Logger, Target};
Logger::new().with_target(Target::Logger(log::Level::Info));
Trait Implementations§
source§impl<F> Handler for Logger<F>where
F: LogFormatter,
impl<F> Handler for Logger<F>where
F: LogFormatter,
source§fn init<'life0, 'life1, 'async_trait>(
&'life0 mut self,
info: &'life1 mut Info,
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn init<'life0, 'life1, 'async_trait>(
&'life0 mut self,
info: &'life1 mut Info,
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Performs one-time async set up on a mutable borrow of the
Handler before the server starts accepting requests. This
allows a Handler to be defined in synchronous code but perform
async setup such as establishing a database connection or
fetching some state from an external source. This is optional,
and chances are high that you do not need this. Read more
source§fn run<'life0, 'async_trait>(
&'life0 self,
conn: Conn,
) -> Pin<Box<dyn Future<Output = Conn> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn run<'life0, 'async_trait>(
&'life0 self,
conn: Conn,
) -> Pin<Box<dyn Future<Output = Conn> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Executes this handler, performing any modifications to the
Conn that are desired.
source§fn before_send<'life0, 'async_trait>(
&'life0 self,
conn: Conn,
) -> Pin<Box<dyn Future<Output = Conn> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn before_send<'life0, 'async_trait>(
&'life0 self,
conn: Conn,
) -> Pin<Box<dyn Future<Output = Conn> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Performs any final modifications to this conn after all handlers
have been run. Although this is a slight deviation from the simple
conn->conn->conn chain represented by most Handlers, it provides
an easy way for libraries to effectively inject a second handler
into a response chain. This is useful for loggers that need to
record information both before and after other handlers have run,
as well as database transaction handlers and similar library code. Read more
source§fn has_upgrade(&self, _upgrade: &Upgrade<BoxedTransport>) -> bool
fn has_upgrade(&self, _upgrade: &Upgrade<BoxedTransport>) -> bool
predicate function answering the question of whether this Handler
would like to take ownership of the negotiated Upgrade. If this
returns true, you must implement
Handler::upgrade
. The first
handler that responds true to this will receive ownership of the
trillium::Upgrade
in a subsequent call to Handler::upgrade
source§fn upgrade<'life0, 'async_trait>(
&'life0 self,
_upgrade: Upgrade<BoxedTransport>,
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>where
'life0: 'async_trait,
Self: 'async_trait,
fn upgrade<'life0, 'async_trait>(
&'life0 self,
_upgrade: Upgrade<BoxedTransport>,
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>where
'life0: 'async_trait,
Self: 'async_trait,
This will only be called if the handler reponds true to
Handler::has_upgrade
and will only be called once for this
upgrade. There is no return value, and this function takes
exclusive ownership of the underlying transport once this is
called. You can downcast the transport to whatever the source
transport type is and perform any non-http protocol communication
that has been negotiated. You probably don’t want this unless
you’re implementing something like websockets. Please note that
for many transports such as TcpStreams, dropping the transport
(and therefore the Upgrade) will hang up / disconnect.Auto Trait Implementations§
impl<F> Freeze for Logger<F>where
F: Freeze,
impl<F> !RefUnwindSafe for Logger<F>
impl<F> Send for Logger<F>where
F: Send,
impl<F> Sync for Logger<F>where
F: Sync,
impl<F> Unpin for Logger<F>where
F: Unpin,
impl<F> !UnwindSafe for Logger<F>
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
Mutably borrows from an owned value. Read more