tofu-logging-structured
API
Generated with
tofu-logging-structured/tofu/tofu.logging/DictLoggable

DictLoggable

tofu.logging.DictLoggable
trait DictLoggable[A] extends Loggable[A]

specialized Loggable for multi-field objects

Attributes

Graph
Supertypes
trait Loggable[A]
trait Base[A]
class Object
trait Matchable
class Any
Known subtypes

Members list

Value members

Concrete methods

override def combinedValue[I, V, R, M, A1 <: A](a: A1, v: V, that: Base[A1])(implicit r: LogRenderer[I, V, R, M]): M

generate the combined value of that loggable and the other at the given position

generate the combined value of that loggable and the other at the given position

Attributes

Definition Classes
override def putField[I, V, R, M](a: A, name: String, input: I)(implicit r: LogRenderer[I, V, R, M]): R

put single logging field value in the field with supplied name

put single logging field value in the field with supplied name

Attributes

Definition Classes
def putValue[I, V, R, M](a: A, v: V)(implicit r: LogRenderer[I, V, R, M]): M

put single logging field value

put single logging field value

Attributes

Inherited methods

def +(that: Base[A]): Loggable[A]

combine two loggables: put fields of both, choose value of first that suits

combine two loggables: put fields of both, choose value of first that suits

Attributes

Inherited from:
Loggable
def contraCollect[B](f: PartialFunction[B, A]): Loggable[B]

contravariant version of collect - log values of type B when they could be converted to A

contravariant version of collect - log values of type B when they could be converted to A

Attributes

Inherited from:
Loggable
def contramap[B](f: B => A): Loggable[B]

transform input value befor logging

transform input value befor logging

Attributes

Inherited from:
Base
def fields[I, V, R, S](a: A, i: I)(implicit r: LogRenderer[I, V, R, S]): R

write all fields of current value in the current object - context

write all fields of current value in the current object - context

Attributes

Inherited from:
Base
def filter(p: A => Boolean): Loggable[A]

log this value whenever predicate holds

log this value whenever predicate holds

Attributes

Inherited from:
Loggable
def filterC[B <: A](p: B => Boolean): Base[B]

same as Loggable.fitler but contravariance-friendly version

same as Loggable.fitler but contravariance-friendly version

Attributes

Inherited from:
Loggable
def hide: Loggable[A]

same as this loggable, but do not show any info in the message string

same as this loggable, but do not show any info in the message string

Attributes

Inherited from:
Loggable
def logAnnotation(name: String): LogAnnotation[A]

Creates a new LogAnnotation using this Loggable with provided name

Creates a new LogAnnotation using this Loggable with provided name

Attributes

Inherited from:
Loggable
def logShow(a: A): String

display value in log message

display value in log message

Value parameters

a

value for logging

Attributes

Returns

displayed form

Inherited from:
Base
def logVia(a: A, addParam: (String, Any) => Unit): Unit

add list of custom fields for value

add list of custom fields for value

Value parameters

a

value for logging

addParam

side-effectful function, adding custom field to log entry

Attributes

Inherited from:
Base
def loggedValue(a: A): LoggedValue

Convert value to LoggedValue

Convert value to LoggedValue

Value parameters

a

value for logging

Attributes

Returns

new Logged Value

Inherited from:
Base
def named(name: String): Loggable[A]

whenever fields are called it would be a single field named name and corresponding value

whenever fields are called it would be a single field named name and corresponding value

Attributes

Inherited from:
Loggable
def narrow[B <: A]: Loggable[B]

Attributes

Inherited from:
Loggable
def plus[B <: A](that: Base[B]): Base[B]

same as Loggable.+ but contravariace-friendly version

same as Loggable.+ but contravariace-friendly version

Attributes

Inherited from:
Loggable
def putMaskedField[I, V, R, S](a: A, name: String, i: I)(f: String => String)(implicit r: LogRenderer[I, V, R, S]): R

put single logging field value in the field with supplied name if it's convertible to string, hide it otherwise

put single logging field value in the field with supplied name if it's convertible to string, hide it otherwise

Attributes

Inherited from:
Base
def putMaskedValue[I, V, R, S](a: A, v: V)(f: String => String)(implicit r: LogRenderer[I, V, R, S]): S

put single logging field value if it's convertible to string, hide it otherwise

put single logging field value if it's convertible to string, hide it otherwise

Attributes

Inherited from:
Base
def shortName: String

Attributes

Inherited from:
Base
def showInstance: Show[A]

Attributes

Inherited from:
Loggable
def singleton(name: String): Loggable[A]

something that works as named on the toplevel but ensures, that field is always represented as a singleton dict inside other value

something that works as named on the toplevel but ensures, that field is always represented as a singleton dict inside other value

Attributes

Inherited from:
Loggable
def typeName: String

Attributes

Inherited from:
Base
Generated with