Struct LogDecorateScope

Disposable struct that adds Decorations to the logs in the scope, or to some particular log

Implements
Inherited Members
Namespace: Unity.Logging
Assembly: Unity.Logging.dll
Syntax
[BurstCompile]
public readonly struct LogDecorateScope : IDisposable
Remarks

Example:

using LogDecorateScope decorConst1 = Log.To(log).Decorate('ConstantExampleLog1', 999999);

or

using LogDecorateScope decorConstAll = Log.Decorate('ToAll', 42);

It will Dispose (unlock) m_Lock that is passed in and was created in .To(log2) The way it works internally is:

ref var dec = ref LogController.BeginEditDecoratePayloadHandles(ref ctx.Lock, out var nBefore);

  -- Adds decoration to(ref dec); --

var payloadHandles = LogController.EndEditDecoratePayloadHandles(ref logController, nBefore);

return new LogDecorateScope(logController.Handle, payloadHandles);

Constructors

LogDecorateScope(LogControllerScopedLock, FixedList64Bytes<PayloadHandle>)

Creates the LogDecorateScope ReleaseDecoratePayloadBufferDeferred(LoggerHandle, FixedList64Bytes<PayloadHandle>)

Declaration
public LogDecorateScope(LogControllerScopedLock @lock, FixedList64Bytes<PayloadHandle> payloadHandles)
Parameters
Type Name Description
LogControllerScopedLock lock

LogControllerScopedLock that is a default if global, or lock that holds some LogController
FixedList64Bytes<PayloadHandle> payloadHandles

Payload handles that will be deferred-released when Dispose is called.
Remarks

Warning: the lock is disposed because it can't be held for the whole scope.

Methods

Dispose()

Payload handles will be deferred-released in this call.

Declaration
public void Dispose()

Implements