Struct StaticCodecVersion

pub struct StaticCodecVersion<const MAJOR: u64, const MINOR: u64, const PATCH: u64>;

Marker type that represents the semantic version of a codec.

The codec’s version can be decoupled from its implementation version to allow implementation changes that have no effect on the codec’s semantics or encoded representation.

StaticCodecVersions serialize transparently to their equivalent Versions. On deserialization, the deserialized Version is checked to be compatible (^) with the StaticCodecVersion, i.e. the StaticCodecVersion must be of a the same or a newer compatible version.

Implementations

impl<const MAJOR: u64, const MINOR: u64, const PATCH: u64> StaticCodecVersion<MAJOR, MINOR, PATCH>

pub const fn version() -> Version

Extract the semantic version.

Trait Implementations

impl<const MAJOR: u64, const MINOR: u64, const PATCH: u64> Clone for StaticCodecVersion<MAJOR, MINOR, PATCH>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const MAJOR: u64, const MINOR: u64, const PATCH: u64> Debug for StaticCodecVersion<MAJOR, MINOR, PATCH>

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

Formats the value using the given formatter.

impl<const MAJOR: u64, const MINOR: u64, const PATCH: u64> Default for StaticCodecVersion<MAJOR, MINOR, PATCH>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, const MAJOR: u64, const MINOR: u64, const PATCH: u64> Deserialize<'de> for StaticCodecVersion<MAJOR, MINOR, PATCH>

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl<const MAJOR: u64, const MINOR: u64, const PATCH: u64> Display for StaticCodecVersion<MAJOR, MINOR, PATCH>

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

Formats the value using the given formatter.

impl<const MAJOR: u64, const MINOR: u64, const PATCH: u64> JsonSchema for StaticCodecVersion<MAJOR, MINOR, PATCH>

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(_gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn always_inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl<const MAJOR: u64, const MINOR: u64, const PATCH: u64> Serialize for StaticCodecVersion<MAJOR, MINOR, PATCH>

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<const MAJOR: u64, const MINOR: u64, const PATCH: u64> Copy for StaticCodecVersion<MAJOR, MINOR, PATCH>