Skip to main content

AugmentedMetadata

Struct AugmentedMetadata 

Source
pub struct AugmentedMetadata {
    pub identity: PluginIdentity,
    pub negotiated_functions: BTreeMap<String, u32>,
    pub negotiated_capabilities: BTreeSet<String>,
    pub handshake_completed_at: i64,
    pub self_check_passed: bool,
    pub self_check_completed_at: i64,
    pub expires_at: i64,
}
Expand description

Augmented metadata combining plugin identity with negotiated capabilities.

This is the single source of truth for negotiated plugin capabilities and versions. It encapsulates the result of a successful handshake and self-check.

Fields§

§identity: PluginIdentity

The plugin’s identity metadata (magic, abi_envelope, name, version).

§negotiated_functions: BTreeMap<String, u32>

Negotiated wire function versions: function_name -> negotiated_version. Ordered via BTreeMap for deterministic serialization.

§negotiated_capabilities: BTreeSet<String>

Negotiated capabilities offered by the plugin. Ordered via BTreeSet for deterministic serialization.

§handshake_completed_at: i64

Unix timestamp (seconds) when handshake was completed.

§self_check_passed: bool

Whether the self-check passed successfully.

§self_check_completed_at: i64

Unix timestamp (seconds) when self-check was completed.

§expires_at: i64

Unix timestamp (seconds) when this metadata expires and re-handshake is needed.

Implementations§

Source§

impl AugmentedMetadata

Source

pub fn validate(&self) -> Result<(), AugmentedMetadataError>

Validate this augmented metadata.

Source

pub fn check_size_limit(&self) -> Result<(), AugmentedMetadataError>

Check that serialized size does not exceed AUGMENTED_METADATA_MAX_BYTES.

Source

pub fn from_handshake_and_self_check( identity: PluginIdentity, negotiated_functions: BTreeMap<String, u32>, negotiated_capabilities: BTreeSet<String>, handshake_completed_at: i64, self_check_passed: bool, self_check_completed_at: i64, ttl_seconds: u64, ) -> Result<Self, AugmentedMetadataError>

Create AugmentedMetadata from handshake and self-check responses.

Combines:

  • Plugin identity from handshake
  • Negotiated functions and capabilities from handshake
  • Self-check result
§Arguments
  • identity - The plugin’s identity metadata
  • negotiated_functions - BTreeMap of function_name -> negotiated_version
  • negotiated_capabilities - BTreeSet of negotiated capability names
  • handshake_completed_at - Timestamp when handshake completed
  • self_check_passed - Whether self-check passed
  • self_check_completed_at - Timestamp when self-check completed
  • ttl_seconds - TTL for this metadata in seconds
Source

pub fn is_expired(&self, now_timestamp: i64) -> bool

Check if this metadata has expired.

Source

pub fn ttl_seconds(&self, now_timestamp: i64) -> i64

Get the TTL remaining in seconds.

Trait Implementations§

Source§

impl Clone for AugmentedMetadata

Source§

fn clone(&self) -> AugmentedMetadata

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AugmentedMetadata

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for AugmentedMetadata

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for AugmentedMetadata

Source§

impl PartialEq for AugmentedMetadata

Source§

fn eq(&self, other: &AugmentedMetadata) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for AugmentedMetadata

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for AugmentedMetadata

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.