Struct EditionInclusion 

pub struct EditionInclusion {
    pub kind: ComponentKind,
    pub component_id: Id,
    pub since: EditionId,
    pub required_vortex_release: Option<&'static str>,
}

Declares that a serialized component is a member of an edition — and of every later edition of the same family. Registered with EditionSession::declare_inclusion.

Fields

kind: ComponentKind

What the membership covers. Ids are unique per kind, so this is part of the member’s identity, not a label.

component_id: Id

The interned component id, e.g. vortex.alp.

since: EditionId

The first edition this component is a member of.

required_vortex_release: Option<&'static str>

The earliest Vortex release supporting this member, recorded from evidence (e.g. compat-fixture history for serialized components). None until recorded.

Implementations

impl EditionInclusion

pub fn new<C: AsComponentId + ?Sized>( kind: ComponentKind, component: &C, since: EditionId, ) -> Self

Declare that a component of kind is a member of since and every later edition of the same family. The component can be named by id string or by vtable.

pub fn array<C: AsComponentId + ?Sized>(encoding: &C, since: EditionId) -> Self

Declare that an array encoding is a member of since and every later edition of the same family.

pub fn dtype<C: AsComponentId + ?Sized>(dtype: &C, since: EditionId) -> Self

Declare that an extension dtype is a member of since and every later edition of the same family.

pub fn validate(&self) -> VortexResult<()>

Validate the declaration’s form: a lowercase namespace.name component id and, if recorded, a well-formed major.minor.patch release. Checked for every declared inclusion by EditionSession::validate.

Trait Implementations

impl Clone for EditionInclusion

fn clone(&self) -> EditionInclusion

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for EditionInclusion

impl Debug for EditionInclusion

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.