docs.unity3d.com
    Show / Hide Table of Contents

    Interface ILoggableMirrorStruct

    Interface that is used by Unity.Logging to understand how to convert a mirror structure into UnsafeText

    Namespace: Unity.Logging
    Syntax
    public interface ILoggableMirrorStruct
    Remarks

    This not typed variant is used inside Unity.Logging, for user usage see ILoggableMirrorStruct<T>

    Methods

    AppendToUnsafeText(ref UnsafeText, ref FormatterStruct, ref LogMemoryManager, ref ArgumentInfo, Int32)

    Method that defines how the origin type should be converted into text form in Unity.Logging. Similar to a ToString.

    Declaration
    bool AppendToUnsafeText(ref UnsafeText output, ref FormatterStruct formatter, ref LogMemoryManager memAllocator, ref ArgumentInfo currArgSlot, int depth)
    Parameters
    Type Name Description
    UnsafeText output

    Where to append

    FormatterStruct formatter

    Current formatter that is used by the sink. Could be json/text/etc.

    LogMemoryManager memAllocator

    Memory manager that holds binary representation of the mirror struct

    ArgumentInfo currArgSlot

    Hole that was used to describe the struct in the log message, for instance {0} or {Number} or {Number:##.0;-##.0}

    Int32 depth

    Current depth, it is a good idea to not append anything if depth is high to avoid stack overflow

    Returns
    Type Description
    Boolean

    True if append was successful, for instance no FormatErrors happened

    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