Class ForyFieldMeta

python/pyfory/field.py:48–71

Fory field metadata extracted from field.metadata. Attributes: id: Field tag ID. -1 is the internal sentinel for no configured ID; >=0 means use tag ID. nullable: Whether null flag is written. Default False. ref: Whether reference tracking is enabled for this field.

@dataclasses.dataclass(frozen=True)
class ForyFieldMeta:
    """
    Fory field metadata extracted from field.metadata.

    Attributes:
        id: Field tag ID. -1 is the internal sentinel for no configured ID; >=0 means use tag ID.
        nullable: Whether null flag is written. Default False.
        ref: Whether reference tracking is enabled for this field. Default False.
        ignore: Whether to ignore this field during serialization. Default False.
        dynamic: Whether type info is written for this field. None means auto-detect.
            - None (default): Auto-detect based on type (abstract=True, concrete=mode-dependent)
            - True: Always write type info (support runtime subtypes)
            - False: Never write type info (use declared type's serializer)
    """

    id: int
    nullable: bool = False
    ref: bool = False
    ignore: bool = False
    dynamic: Optional[bool] = None

    def uses_tag_id(self) -> bool:
        """Returns True if this field uses tag ID encoding (id >= 0)."""
        return self.id >= 0


@dataclasses.dataclass(frozen=True)