Struct ScyllaCore.Meta
Contains compile-time metadata constants that describe the Scylla Framework core. Use these constants in log messages, version checks, and dependency declarations that reference the framework's own identity rather than that of a specific module.
Inherited Members
Namespace: Scylla.Core
Assembly: ScyllaCore.dll
Syntax
public struct ScyllaCore.MetaRemarks
The ID constant mirrors CORE, which is
the canonical source for the core ID string. The two are kept in sync intentionally:
Meta.ID is convenient for code inside the Scylla.Core namespace,
while CORE is the public cross-assembly constant.
Fields
API_DOCS_URL
URL of the generated API reference for the Scylla Framework core. Composed
as {ScyllaCore.URL_API_DOCS_BASE}core/. Used by editor surfaces to
deep-link the user to type-level documentation.
Declaration
public const string API_DOCS_URL = "https://apidocs.scyllaframework.com/core/"Field Value
| Type | Description |
|---|---|
| string |
DESCRIPTION
A short human-readable sentence describing the purpose of the Scylla Framework core. Printed in the startup log immediately after the version header.
Declaration
public const string DESCRIPTION = "Provides the common core facilities and utilities that are shared among all Scylla modules."Field Value
| Type | Description |
|---|---|
| string |
DOCS_URL
URL of the user-facing documentation for the Scylla Framework core. Composed
as {ScyllaCore.URL_DOCS_BASE}core/. Used by editor surfaces (e.g. the
Getting Started window) to deep-link the user to module-specific docs.
Declaration
public const string DOCS_URL = "https://scyllaframework.com/docs-category/core/"Field Value
| Type | Description |
|---|---|
| string |
ID
The canonical string identifier for the Scylla Framework core.
Mirrors CORE and is used in log output and
exception messages that originate from core infrastructure rather than from
a specific module. This ID is NOT valid as an argument to
GetModule(string) because
ScyllaCore is not registered as a module.
Declaration
public const string ID = "ScyllaCore"Field Value
| Type | Description |
|---|---|
| string |
NAME
The full display name of the Scylla Framework core, used in startup log
headers and diagnostic output.
Value: "Scylla Core".
Declaration
public const string NAME = "Scylla Core"Field Value
| Type | Description |
|---|---|
| string |
SHORT_NAME
The abbreviated display name of the framework, used in contexts where
space is limited such as log prefixes or UI labels.
Value: "Scylla".
Declaration
public const string SHORT_NAME = "Scylla"Field Value
| Type | Description |
|---|---|
| string |
VERSION
The semantic version string of the Scylla Framework core in
MAJOR.MINOR.PATCH format. Logged at startup and may be compared
against module minimum-version requirements declared via
MinVersion.
Value: "1.2.0".
Declaration
public const string VERSION = "1.2.0"Field Value
| Type | Description |
|---|---|
| string |