Struct OnLogMessageFormatterDelegate

Struct that wraps OnLogMessageFormatterDelegate for a sink

Inherited Members

ValueType.Equals(Object)

ValueType.GetHashCode()

ValueType.ToString()

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetType()

Namespace: Unity.Logging.Sinks

Syntax

public readonly struct OnLogMessageFormatterDelegate

Constructors

OnLogMessageFormatterDelegate(OnLogMessageFormatterDelegate.Delegate)

Constructor that takes the delegate and compiles it with burst

Declaration

public OnLogMessageFormatterDelegate(OnLogMessageFormatterDelegate.Delegate func)

Parameters

Type	Name	Description
OnLogMessageFormatterDelegate.Delegate	func	Delegate to compile

Properties

IsCreated

True if function pointer was created

Declaration

public readonly bool IsCreated { get; }

Property Value

Type	Description
Boolean

Methods

Invoke(in LogMessage, ref FormatterStruct, ref FixedString512Bytes, ref UnsafeText, IntPtr, IntPtr, Allocator)

Invoke the compiled delegate to convert message into UnsafeText

Declaration

public readonly int Invoke(in LogMessage logEvent, ref FormatterStruct formatter, ref FixedString512Bytes outTemplate, ref UnsafeText messageBuffer, IntPtr memoryManager, IntPtr userData, Allocator allocator)

Parameters

Type	Name	Description
LogMessage	logEvent	Log message event
FormatterStruct	formatter	Formatter that sink is using
FixedString512Bytes	outTemplate	Template that sink is using
UnsafeText	messageBuffer	Text representation of the message
IntPtr	memoryManager	Memory manager that owns Log message
IntPtr	userData	User data
Allocator	allocator	Allocator that should be used in case of any allocation needed

Returns

Type	Description
Int32	Length of the messageOutput. Negative on error