Struct Catalog 

pub struct Catalog {
    pub version: Value,
    pub tags: IndexMap<String, Node>,
    pub types: IndexMap<String, TypeDef>,
    /* private fields */
}

The controller structure: tags and structure types (string types left out).

Fields

version: Value

The tag table version.

tags: IndexMap<String, Node>

Tags by name, in upload order.

types: IndexMap<String, TypeDef>

Structure types by name.

Implementations

impl Catalog

pub fn new( version: Json, tags: IndexMap<String, Node>, types: IndexMap<String, TypeDef>, ) -> Self

A catalog of these tags and types; computes the lookup index and which types read whole.

pub fn tag(&self, name: &str) -> Option<&Node>

A tag by name, ignoring case.

pub fn type_def(&self, name: &str) -> Option<&TypeDef>

A structure type by name.

pub fn info(&self, name: &str) -> Option<&Node>

The definition of a tag or member path, indexes and element counts ignored (as ciplink’s get_tag_info); None for unknown names and bits.

pub fn struct_size(&self, node: &Node) -> Option<u64>

The structure size of a struct node that can be read whole, else None.

pub fn tag_list(&self) -> Vec<Json>

GET /tags tags: name, type, dims of arrays and, for AOIs, the readable members.

pub fn type_map(&self) -> Map<String, Json>

GET /tags types: UDT and AOI name -> {"members": {m: {type, dims?}}, "aoi"?: true}; private members hidden.

Trait Implementations

impl Clone for Catalog

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Catalog

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

Formats the value using the given formatter.

impl Default for Catalog

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Catalog

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Catalog