1. Home
  2. API
  3. Tomlyn

Tomlyn Namespace

Top-level APIs for parsing, round-trippable syntax trees, and System.Text.Json-style TOML serialization with Tomlyn.

Classes (8)

TomlDerivedTypeRepresents a derived type mapping for runtime polymorphic TOML configuration.
TomlExceptionException thrown when parsing or serializing TOML fails.
TomlPolymorphismOptionsConfigures discriminator-based polymorphism.
TomlSerializerSerializes and deserializes TOML payloads, following a System.Text.Json-style API shape.
TomlSerializerOptionsConfigures the behavior of TomlSerializer operations.
TomlStringStylePreferencesConfigures string scalar style preferences for TOML serialization.
TomlTypeInfoRepresents metadata and operations for a serializable type.
TomlTypeInfo<T>Represents metadata and operations for a specific serializable type.

Structs (1)

TomlDateTimeA datetime value that can represent a TOML - An offset DateTime with Zero offset or Number offset. - A local DateTime. - A local Date. - A local Time.

Interfaces (1)

ITomlTypeInfoResolverResolves type metadata used by TomlSerializer.

Enums (11)

TomlDateTimeKindOffsets used for a TomlDateTime
TomlDottedKeyHandlingSpecifies behavior for dictionary keys containing '.'.
TomlDuplicateKeyHandlingSpecifies behavior when duplicate keys are encountered.
TomlIgnoreConditionSpecifies when a member should be ignored during TOML serialization.
TomlInlineTablePolicySpecifies inline table emission policy.
TomlMappingOrderPolicySpecifies member ordering behavior for emitted mappings.
TomlNewLineKindSpecifies newline kind.
TomlRootValueHandlingSpecifies behavior for scalar/array roots that do not naturally map to a TOML document.
TomlStringStyleSpecifies preferred default string style.
TomlTableArrayStyleSpecifies how arrays of tables are emitted.
TomlUnknownDerivedTypeHandlingSpecifies behavior when an unknown derived type discriminator is encountered.

Remarks

This namespace contains the main entry points for most applications:

  • TomlSerializer and TomlSerializerOptions for object serialization.
  • TomlException for errors with precise source locations.
  • TomlTypeInfo<T> and ITomlTypeInfoResolver for metadata-driven (AOT-friendly) serialization.