logo SERENITY
Game Systems Foundation
Search Results for

    Show / Hide Table of Contents

    Interface ICustomStructuredBackendDefinition

    Extension point for project-defined structured-store backends. Implement this interface on a UnityStructuredBackendDefinition subclass in your own assembly and assign the asset wherever a backend definition is accepted (e.g. UnityStructuredLogSettings.Backend): consumer factories check for this interface BEFORE their built-in backend types, so a custom definition takes precedence over the built-in construction paths.

    Namespace: Serenity.StructuredPersistence.Extensibility
    Assembly: Serenity.UnityStructuredPersistence.Extensibility.dll
    Syntax
    public interface ICustomStructuredBackendDefinition

    Methods

    CreateStore(ILogService)

    Creates the custom structured store this definition configures.

    Declaration
    IStructuredStore CreateStore(ILogService logService)
    Parameters
    Type Name Description
    ILogService logService

    Logging service the store may use to report its own failures. May be null.

    Returns
    Type Description
    IStructuredStore

    The constructed store, or null when the backend cannot be constructed.

    Remarks

    Contract: this method MAY throw, and MAY return null — the calling factory treats both as "backend unavailable", logs a warning, and falls back to its built-in default backend. Never let a failure here crash the caller by other means (e.g. background threads); construction runs synchronously during installation.

    In this article
    © 2026 Serenity. All Rights Reserved