Struct diagnostics_log::PublisherOptions

pub struct PublisherOptions<'t> { /* private fields */ }

Options to configure a Publisher.

Implementations

impl PublisherOptions<'_>

pub fn empty() -> Self

Creates a PublishOptions with all sets either empty or set to false. This is useful when fine grain control of Publisher and its behavior is necessary.

However, for the majority of binaries that “just want to log”, PublishOptions::default is preferred as that brings all the default configuration that is desired in most scenarios.

impl<'t> PublisherOptions<'t>

pub fn wait_for_initial_interest(self, enable: bool) -> Self

Whether or not to block on initial runtime interest being received before starting to emit log records using the default interest configured.

It’s recommended that this is set when developing to guarantee that a dynamically configured minimum severity makes it to the component before it starts emitting logs.

Default: true.

pub fn listen_for_interest_updates(self, enable: bool) -> Self

When set, a fuchsia_async::Task will be spawned and held that will be listening for interest changes.

Default: true

pub fn use_log_sink(self, proxy: LogSinkProxy) -> Self

Sets the LogSink that will be used.

Default: the fuchsia.logger.LogSink available in the incoming namespace.

pub fn blocking(self, is_blocking: bool) -> Self

When set to true, writes to the log socket will be blocking. This is, we’ll retry every time the socket buffer is full until we are able to write the log.

Default: false

impl<'t> PublisherOptions<'t>

pub fn tags(self, tags: &'t [&'t str]) -> Self

Sets the tags applied to all published events.

When set to an empty slice (the default), events are tagged with the moniker of the component in which they are recorded.

Default: empty.

pub fn enable_metatag(self, metatag: Metatag) -> Self

Enable a metatag. It’ll be applied to all published events.

Default: no metatags are enabled.

pub fn minimum_severity(self, severity: impl IntoSeverity) -> Self

An interest filter to apply to messages published.

Default: EMPTY, which implies INFO.

Trait Implementations

impl<'t> Default for PublisherOptions<'t>

fn default() -> Self

Returns the “default value” for a type.