Derive Macro rkyv_derive::Archive

#[derive(Archive)]
{
    // Attributes available to this derive:
    #[archive]
    #[omit_bounds]
}

Derives Archive for the labeled type.

Additional arguments can be specified using the #[archive(...)] attribute:

• copy: Implements ArchiveCopy as well as Archive. Only suitable for types that can be directly archived (i.e. plain data).
• compare(...): Implements common comparison operators between the original and archived types. Supported comparisons are PartialEq and PartialOrd (i.e. #[archive(compare(PartialEq, PartialOrd))]).
• derive(...): Adds a #[derive(...)] attribute to the archived type.
• name, name = "...": Exposes the archived type with the given name. If used without a name assignment, uses the name "Archived" + name.
• strict: Marks structs at #[repr(C)] for strictly guaranteed stability and compatibility. This is equivalent to enabling the strict feature for only this struct.
• bound(...): Adds additional bounds to the Serialize and Deserialize implementations. This can be especially useful when dealing with recursive structures, where bounds may need to be omitted to prevent recursive type definitions.

This derive macro automatically adds a type bound field: Archive for each field type. This can cause an overflow while evaluating trait bounds if the structure eventually references its own type, as the implementation of Archive for a struct depends on each field type implementing it as well. Adding the attribute #[omit_bounds] to a field will suppress this trait bound and allow recursive structures. This may be too coarse for some types, in which case additional type bounds may be required with bound(...).