docs.unity3d.com
    Show / Hide Table of Contents

    Struct LogDecorateScope

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

    Inherited Members
    ValueType.Equals(Object)
    ValueType.GetHashCode()
    ValueType.ToString()
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Namespace: Unity.Logging
    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 Unity.Logging.Internal.LoggerManager.ReleaseDecoratePayloadBufferDeferred(Unity.Logging.LoggerHandle,Unity.Collections.FixedList64Bytes{Unity.Logging.PayloadHandle})

    Declaration
    public LogDecorateScope(LogControllerScopedLock lock, FixedList64Bytes<PayloadHandle> payloadHandles)
    Parameters
    Type Name Description
    Unity.Logging.Internal.LogControllerScopedLock lock Unity.Logging.Internal.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 readonly void Dispose()
    Implements
    IDisposable.Dispose()
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023