sim-table-remote 0.1.0-rc.1

SIM workspace package for sim table remote.
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

use sim_citizen_derive::Citizen;
use sim_kernel::Symbol;

/// Citizen record describing a [`RemoteDir`](crate::RemoteDir) and its backing
/// site.
#[derive(Clone, Debug, PartialEq, Citizen)]
#[citizen(symbol = "table/RemoteDir", version = 0)]
pub struct RemoteDirDescriptor {
    /// Identifier of the remote site kind backing the directory.
    pub site_kind: String,
    /// Codec used to encode and decode rows over the wire.
    #[citizen(with = "sim_table_core::citizen_fields::symbol")]
    pub codec: Symbol,
    /// Path segments locating the directory within the remote site.
    #[citizen(with = "sim_table_core::citizen_fields::path_segments")]
    pub path: Vec<String>,
}

impl Default for RemoteDirDescriptor {
    fn default() -> Self {
        Self {
            site_kind: String::new(),
            codec: Symbol::qualified("codec", "binary"),
            path: Vec::new(),
        }
    }
}

/// Returns the citizen class symbol for [`RemoteDirDescriptor`].
pub fn remote_dir_class_symbol() -> Symbol {
    Symbol::qualified("table", "RemoteDir")
}