Struct Index 

pub struct Index {
    pub index_schema_version: IndexSchemaVersion,
    pub artifacts_url: ArtifactsUrl,
    pub plugins: Vec<IndexEntry>,
}

A parsed plugin registry index.

Fields

index_schema_version: IndexSchemaVersion

artifacts_url: ArtifactsUrl

plugins: Vec<IndexEntry>

Implementations

impl Index

pub fn parse_json(input: &str) -> Result<Index, SchemaErrors>

Parses an index from JSON, collecting every field-level defect from every entry in one pass (including duplicate (name, version) pairs).

Syntax errors and an unsupported/malformed index_schema_version short-circuit with a single error.

Examples

use influxdb3_plugin_schemas::Index;

let source = r#"{
  "index_schema_version": "2.0",
  "artifacts_url": "https://plugins.example.com/artifacts",
  "plugins": []
}"#;

let index = Index::parse_json(source).unwrap();
assert!(index.plugins.is_empty());

pub fn to_canonical_json(&self) -> Result<String, SchemaError>

Serializes this index to its canonical JSON form:

• Field ordering matches struct declaration order.
• plugins[] sorted by name ascending, then version ascending by SemVer precedence. Metadata fields such as published_at and yank status do not affect ordering.
• 2-space indent, pretty-printed, trailing newline.
• NFC Unicode normalization on free-text description fields. Other string fields are already ASCII-constrained by their validators; URL fields normalize via url::Url parse.

pub fn check_entry_insert( &self, entry: &IndexEntry, ) -> Result<(), IndexInsertError>

Checks whether entry can be inserted into this index without violating uniqueness or canonical-collision invariants.

Returns Ok(()) when the insert would be safe, or an crate::IndexInsertError describing the conflict.

This method does not modify the index.

pub fn push_entry(&mut self, entry: IndexEntry) -> Result<(), IndexInsertError>

Validates entry against the current index and, if valid, appends it to self.plugins.

Returns Err without modifying the index when the entry would create a duplicate (name, version) pair or a canonical-name collision.

impl Index

pub fn search(&self, query: &IndexSearchQuery) -> IndexSearchResult

pub fn info(&self, query: &IndexInfoQuery) -> IndexInfoResult

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Index

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Index

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Index

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Index