Struct PublisherOptions Copy item path

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 log_file_line_info(self, enable: bool) -> Self

Whether or not to log file/line information regardless of severity.

Default: false.

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 Into<Severity>) -> Self

An interest filter to apply to messages published.

Default: EMPTY, which implies INFO.

Trait Implementations§

impl Default for PublisherOptions<'_>

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

impl<'t> !UnwindSafe for PublisherOptions<'t>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T, D> Encode<Ambiguous1, D> for T
where D: ResourceDialect,

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more

impl<T, D> Encode<Ambiguous2, D> for T
where D: ResourceDialect,

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoAny for T
where T: 'static + Send + Sync,

fn into_any(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Cast the given object into a dyn std::any::Any.

impl<T> IntoEither for T

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

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