mecha10-core 0.6.2

Mecha10 core runtime and foundational types
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

//! `SchemaRegistryExt`: the Redis-backed schema registry API.

use super::MessageSchema;
use crate::error::Result;

/// Schema registry extension trait for Context
pub trait SchemaRegistryExt {
    /// Register a schema in the registry
    ///
    /// # Arguments
    ///
    /// * `schema` - Schema to register
    ///
    /// # Example
    ///
    /// ```rust
    /// use mecha10::prelude::*;
    /// use mecha10::schema::{SchemaRegistryExt, MessageSchema};
    ///
    /// # async fn example(ctx: &Context) -> Result<()> {
    /// let schema = MessageSchema::new("LaserScan", 1)
    ///     .with_description("2D laser scan data")
    ///     .with_field("timestamp", "integer", true)
    ///     .with_field("ranges", "array", true);
    ///
    /// ctx.register_schema(&schema).await?;
    /// # Ok(())
    /// # }
    /// ```
    fn register_schema(&self, schema: &MessageSchema) -> impl std::future::Future<Output = Result<()>> + Send;

    /// Get a specific version of a schema
    ///
    /// # Arguments
    ///
    /// * `name` - Schema name
    /// * `version` - Schema version
    fn get_schema(
        &self,
        name: &str,
        version: u32,
    ) -> impl std::future::Future<Output = Result<Option<MessageSchema>>> + Send;

    /// Get the latest version of a schema
    ///
    /// # Arguments
    ///
    /// * `name` - Schema name
    fn get_latest_schema(&self, name: &str) -> impl std::future::Future<Output = Result<Option<MessageSchema>>> + Send;

    /// List all registered schemas (returns latest version of each)
    fn list_schemas(&self) -> impl std::future::Future<Output = Result<Vec<MessageSchema>>> + Send;

    /// Get all versions of a schema
    ///
    /// # Arguments
    ///
    /// * `name` - Schema name
    fn get_schema_versions(&self, name: &str) -> impl std::future::Future<Output = Result<Vec<MessageSchema>>> + Send;

    /// Delete a schema version
    ///
    /// # Arguments
    ///
    /// * `name` - Schema name
    /// * `version` - Schema version (if None, deletes all versions)
    fn delete_schema(&self, name: &str, version: Option<u32>) -> impl std::future::Future<Output = Result<()>> + Send;
}

// The `impl SchemaRegistryExt for Context` block lives in `registry_impl.rs`
// to keep the trait's public API and its Redis-backed implementation in
// separately readable files.